AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

Lightsail

import "github.com/aws/aws-sdk-go/service/lightsail"

type Lightsail struct { *client.Client }

Lightsail provides the API operation methods for making requests to Amazon Lightsail. See this package's package overview docs for details on the service.

Lightsail methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

Client

Type: *client.Client

Method

AllocateStaticIp

func (c *Lightsail) AllocateStaticIp(input *AllocateStaticIpInput) (*AllocateStaticIpOutput, error)

AllocateStaticIp API operation for Amazon Lightsail.

Allocates a static IP address.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation AllocateStaticIp for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AllocateStaticIp

AllocateStaticIpRequest

func (c *Lightsail) AllocateStaticIpRequest(input *AllocateStaticIpInput) (req *request.Request, output *AllocateStaticIpOutput)

AllocateStaticIpRequest generates a "aws/request.Request" representing the client's request for the AllocateStaticIp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AllocateStaticIp for more information on using the AllocateStaticIp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AllocateStaticIpRequest method. req, resp := client.AllocateStaticIpRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AllocateStaticIp

AllocateStaticIpWithContext

func (c *Lightsail) AllocateStaticIpWithContext(ctx aws.Context, input *AllocateStaticIpInput, opts ...request.Option) (*AllocateStaticIpOutput, error)

AllocateStaticIpWithContext is the same as AllocateStaticIp with the addition of the ability to pass a context and additional request options.

See AllocateStaticIp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

AttachDisk

func (c *Lightsail) AttachDisk(input *AttachDiskInput) (*AttachDiskOutput, error)

AttachDisk API operation for Amazon Lightsail.

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 diskName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation AttachDisk for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachDisk

AttachDiskRequest

func (c *Lightsail) AttachDiskRequest(input *AttachDiskInput) (req *request.Request, output *AttachDiskOutput)

AttachDiskRequest generates a "aws/request.Request" representing the client's request for the AttachDisk operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachDisk for more information on using the AttachDisk API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachDiskRequest method. req, resp := client.AttachDiskRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachDisk

AttachDiskWithContext

func (c *Lightsail) AttachDiskWithContext(ctx aws.Context, input *AttachDiskInput, opts ...request.Option) (*AttachDiskOutput, error)

AttachDiskWithContext is the same as AttachDisk with the addition of the ability to pass a context and additional request options.

See AttachDisk for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

AttachInstancesToLoadBalancer

func (c *Lightsail) AttachInstancesToLoadBalancer(input *AttachInstancesToLoadBalancerInput) (*AttachInstancesToLoadBalancerOutput, error)

AttachInstancesToLoadBalancer API operation for Amazon Lightsail.

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 loadBalancerName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation AttachInstancesToLoadBalancer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachInstancesToLoadBalancer

AttachInstancesToLoadBalancerRequest

func (c *Lightsail) AttachInstancesToLoadBalancerRequest(input *AttachInstancesToLoadBalancerInput) (req *request.Request, output *AttachInstancesToLoadBalancerOutput)

AttachInstancesToLoadBalancerRequest generates a "aws/request.Request" representing the client's request for the AttachInstancesToLoadBalancer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachInstancesToLoadBalancer for more information on using the AttachInstancesToLoadBalancer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachInstancesToLoadBalancerRequest method. req, resp := client.AttachInstancesToLoadBalancerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachInstancesToLoadBalancer

AttachInstancesToLoadBalancerWithContext

func (c *Lightsail) AttachInstancesToLoadBalancerWithContext(ctx aws.Context, input *AttachInstancesToLoadBalancerInput, opts ...request.Option) (*AttachInstancesToLoadBalancerOutput, error)

AttachInstancesToLoadBalancerWithContext is the same as AttachInstancesToLoadBalancer with the addition of the ability to pass a context and additional request options.

See AttachInstancesToLoadBalancer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

AttachLoadBalancerTlsCertificate

func (c *Lightsail) AttachLoadBalancerTlsCertificate(input *AttachLoadBalancerTlsCertificateInput) (*AttachLoadBalancerTlsCertificateOutput, error)

AttachLoadBalancerTlsCertificate API operation for Amazon Lightsail.

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 operation with the non-attached certificate, and it will replace the existing one and become the attached certificate.

The attach load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation AttachLoadBalancerTlsCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachLoadBalancerTlsCertificate

AttachLoadBalancerTlsCertificateRequest

func (c *Lightsail) AttachLoadBalancerTlsCertificateRequest(input *AttachLoadBalancerTlsCertificateInput) (req *request.Request, output *AttachLoadBalancerTlsCertificateOutput)

AttachLoadBalancerTlsCertificateRequest generates a "aws/request.Request" representing the client's request for the AttachLoadBalancerTlsCertificate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachLoadBalancerTlsCertificate for more information on using the AttachLoadBalancerTlsCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachLoadBalancerTlsCertificateRequest method. req, resp := client.AttachLoadBalancerTlsCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachLoadBalancerTlsCertificate

AttachLoadBalancerTlsCertificateWithContext

func (c *Lightsail) AttachLoadBalancerTlsCertificateWithContext(ctx aws.Context, input *AttachLoadBalancerTlsCertificateInput, opts ...request.Option) (*AttachLoadBalancerTlsCertificateOutput, error)

AttachLoadBalancerTlsCertificateWithContext is the same as AttachLoadBalancerTlsCertificate with the addition of the ability to pass a context and additional request options.

See AttachLoadBalancerTlsCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

AttachStaticIp

func (c *Lightsail) AttachStaticIp(input *AttachStaticIpInput) (*AttachStaticIpOutput, error)

AttachStaticIp API operation for Amazon Lightsail.

Attaches a static IP address to a specific Amazon Lightsail instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation AttachStaticIp for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachStaticIp

AttachStaticIpRequest

func (c *Lightsail) AttachStaticIpRequest(input *AttachStaticIpInput) (req *request.Request, output *AttachStaticIpOutput)

AttachStaticIpRequest generates a "aws/request.Request" representing the client's request for the AttachStaticIp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachStaticIp for more information on using the AttachStaticIp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachStaticIpRequest method. req, resp := client.AttachStaticIpRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachStaticIp

AttachStaticIpWithContext

func (c *Lightsail) AttachStaticIpWithContext(ctx aws.Context, input *AttachStaticIpInput, opts ...request.Option) (*AttachStaticIpOutput, error)

AttachStaticIpWithContext is the same as AttachStaticIp with the addition of the ability to pass a context and additional request options.

See AttachStaticIp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CloseInstancePublicPorts

func (c *Lightsail) CloseInstancePublicPorts(input *CloseInstancePublicPortsInput) (*CloseInstancePublicPortsOutput, error)

CloseInstancePublicPorts API operation for Amazon Lightsail.

Closes the public ports on a specific Amazon Lightsail instance.

The close instance public ports operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CloseInstancePublicPorts for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CloseInstancePublicPorts

CloseInstancePublicPortsRequest

func (c *Lightsail) CloseInstancePublicPortsRequest(input *CloseInstancePublicPortsInput) (req *request.Request, output *CloseInstancePublicPortsOutput)

CloseInstancePublicPortsRequest generates a "aws/request.Request" representing the client's request for the CloseInstancePublicPorts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CloseInstancePublicPorts for more information on using the CloseInstancePublicPorts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CloseInstancePublicPortsRequest method. req, resp := client.CloseInstancePublicPortsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CloseInstancePublicPorts

CloseInstancePublicPortsWithContext

func (c *Lightsail) CloseInstancePublicPortsWithContext(ctx aws.Context, input *CloseInstancePublicPortsInput, opts ...request.Option) (*CloseInstancePublicPortsOutput, error)

CloseInstancePublicPortsWithContext is the same as CloseInstancePublicPorts with the addition of the ability to pass a context and additional request options.

See CloseInstancePublicPorts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CopySnapshot

func (c *Lightsail) CopySnapshot(input *CopySnapshotInput) (*CopySnapshotOutput, error)

CopySnapshot API operation for Amazon Lightsail.

Copies an instance or disk snapshot from one AWS Region to another in Amazon Lightsail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CopySnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CopySnapshot

CopySnapshotRequest

func (c *Lightsail) CopySnapshotRequest(input *CopySnapshotInput) (req *request.Request, output *CopySnapshotOutput)

CopySnapshotRequest generates a "aws/request.Request" representing the client's request for the CopySnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CopySnapshot for more information on using the CopySnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CopySnapshotRequest method. req, resp := client.CopySnapshotRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CopySnapshot

CopySnapshotWithContext

func (c *Lightsail) CopySnapshotWithContext(ctx aws.Context, input *CopySnapshotInput, opts ...request.Option) (*CopySnapshotOutput, error)

CopySnapshotWithContext is the same as CopySnapshot with the addition of the ability to pass a context and additional request options.

See CopySnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateCloudFormationStack

func (c *Lightsail) CreateCloudFormationStack(input *CreateCloudFormationStackInput) (*CreateCloudFormationStackOutput, error)

CreateCloudFormationStack API operation for Amazon Lightsail.

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.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateCloudFormationStack for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateCloudFormationStack

CreateCloudFormationStackRequest

func (c *Lightsail) CreateCloudFormationStackRequest(input *CreateCloudFormationStackInput) (req *request.Request, output *CreateCloudFormationStackOutput)

CreateCloudFormationStackRequest generates a "aws/request.Request" representing the client's request for the CreateCloudFormationStack operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCloudFormationStack for more information on using the CreateCloudFormationStack API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateCloudFormationStackRequest method. req, resp := client.CreateCloudFormationStackRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateCloudFormationStack

CreateCloudFormationStackWithContext

func (c *Lightsail) CreateCloudFormationStackWithContext(ctx aws.Context, input *CreateCloudFormationStackInput, opts ...request.Option) (*CreateCloudFormationStackOutput, error)

CreateCloudFormationStackWithContext is the same as CreateCloudFormationStack with the addition of the ability to pass a context and additional request options.

See CreateCloudFormationStack for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateDisk

func (c *Lightsail) CreateDisk(input *CreateDiskInput) (*CreateDiskOutput, error)

CreateDisk API operation for Amazon Lightsail.

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 (https://lightsail.aws.amazon.com/ls/docs/overview/article/understanding-regions-and-availability-zones-in-amazon-lightsail).

The create disk operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateDisk for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDisk

CreateDiskFromSnapshot

func (c *Lightsail) CreateDiskFromSnapshot(input *CreateDiskFromSnapshotInput) (*CreateDiskFromSnapshotOutput, error)

CreateDiskFromSnapshot API operation for Amazon Lightsail.

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 (https://lightsail.aws.amazon.com/ls/docs/overview/article/understanding-regions-and-availability-zones-in-amazon-lightsail).

The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by diskSnapshotName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateDiskFromSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskFromSnapshot

CreateDiskFromSnapshotRequest

func (c *Lightsail) CreateDiskFromSnapshotRequest(input *CreateDiskFromSnapshotInput) (req *request.Request, output *CreateDiskFromSnapshotOutput)

CreateDiskFromSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateDiskFromSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDiskFromSnapshot for more information on using the CreateDiskFromSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDiskFromSnapshotRequest method. req, resp := client.CreateDiskFromSnapshotRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskFromSnapshot

CreateDiskFromSnapshotWithContext

func (c *Lightsail) CreateDiskFromSnapshotWithContext(ctx aws.Context, input *CreateDiskFromSnapshotInput, opts ...request.Option) (*CreateDiskFromSnapshotOutput, error)

CreateDiskFromSnapshotWithContext is the same as CreateDiskFromSnapshot with the addition of the ability to pass a context and additional request options.

See CreateDiskFromSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateDiskRequest

func (c *Lightsail) CreateDiskRequest(input *CreateDiskInput) (req *request.Request, output *CreateDiskOutput)

CreateDiskRequest generates a "aws/request.Request" representing the client's request for the CreateDisk operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDisk for more information on using the CreateDisk API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDiskRequest method. req, resp := client.CreateDiskRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDisk

CreateDiskSnapshot

func (c *Lightsail) CreateDiskSnapshot(input *CreateDiskSnapshotInput) (*CreateDiskSnapshotOutput, error)

CreateDiskSnapshot API operation for Amazon Lightsail.

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 Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateDiskSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskSnapshot

CreateDiskSnapshotRequest

func (c *Lightsail) CreateDiskSnapshotRequest(input *CreateDiskSnapshotInput) (req *request.Request, output *CreateDiskSnapshotOutput)

CreateDiskSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateDiskSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDiskSnapshot for more information on using the CreateDiskSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDiskSnapshotRequest method. req, resp := client.CreateDiskSnapshotRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskSnapshot

CreateDiskSnapshotWithContext

func (c *Lightsail) CreateDiskSnapshotWithContext(ctx aws.Context, input *CreateDiskSnapshotInput, opts ...request.Option) (*CreateDiskSnapshotOutput, error)

CreateDiskSnapshotWithContext is the same as CreateDiskSnapshot with the addition of the ability to pass a context and additional request options.

See CreateDiskSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateDiskWithContext

func (c *Lightsail) CreateDiskWithContext(ctx aws.Context, input *CreateDiskInput, opts ...request.Option) (*CreateDiskOutput, error)

CreateDiskWithContext is the same as CreateDisk with the addition of the ability to pass a context and additional request options.

See CreateDisk for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateDomain

func (c *Lightsail) CreateDomain(input *CreateDomainInput) (*CreateDomainOutput, error)

CreateDomain API operation for Amazon Lightsail.

Creates a domain resource for the specified domain (e.g., example.com).

The create domain operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateDomain for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDomain

CreateDomainEntry

func (c *Lightsail) CreateDomainEntry(input *CreateDomainEntryInput) (*CreateDomainEntryOutput, error)

CreateDomainEntry API operation for Amazon Lightsail.

Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.

The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateDomainEntry for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDomainEntry

CreateDomainEntryRequest

func (c *Lightsail) CreateDomainEntryRequest(input *CreateDomainEntryInput) (req *request.Request, output *CreateDomainEntryOutput)

CreateDomainEntryRequest generates a "aws/request.Request" representing the client's request for the CreateDomainEntry operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDomainEntry for more information on using the CreateDomainEntry API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDomainEntryRequest method. req, resp := client.CreateDomainEntryRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDomainEntry

CreateDomainEntryWithContext

func (c *Lightsail) CreateDomainEntryWithContext(ctx aws.Context, input *CreateDomainEntryInput, opts ...request.Option) (*CreateDomainEntryOutput, error)

CreateDomainEntryWithContext is the same as CreateDomainEntry with the addition of the ability to pass a context and additional request options.

See CreateDomainEntry for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateDomainRequest

func (c *Lightsail) CreateDomainRequest(input *CreateDomainInput) (req *request.Request, output *CreateDomainOutput)

CreateDomainRequest generates a "aws/request.Request" representing the client's request for the CreateDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDomain for more information on using the CreateDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDomainRequest method. req, resp := client.CreateDomainRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDomain

CreateDomainWithContext

func (c *Lightsail) CreateDomainWithContext(ctx aws.Context, input *CreateDomainInput, opts ...request.Option) (*CreateDomainOutput, error)

CreateDomainWithContext is the same as CreateDomain with the addition of the ability to pass a context and additional request options.

See CreateDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateInstanceSnapshot

func (c *Lightsail) CreateInstanceSnapshot(input *CreateInstanceSnapshotInput) (*CreateInstanceSnapshotOutput, error)

CreateInstanceSnapshot API operation for Amazon Lightsail.

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 Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateInstanceSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstanceSnapshot

CreateInstanceSnapshotRequest

func (c *Lightsail) CreateInstanceSnapshotRequest(input *CreateInstanceSnapshotInput) (req *request.Request, output *CreateInstanceSnapshotOutput)

CreateInstanceSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateInstanceSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateInstanceSnapshot for more information on using the CreateInstanceSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateInstanceSnapshotRequest method. req, resp := client.CreateInstanceSnapshotRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstanceSnapshot

CreateInstanceSnapshotWithContext

func (c *Lightsail) CreateInstanceSnapshotWithContext(ctx aws.Context, input *CreateInstanceSnapshotInput, opts ...request.Option) (*CreateInstanceSnapshotOutput, error)

CreateInstanceSnapshotWithContext is the same as CreateInstanceSnapshot with the addition of the ability to pass a context and additional request options.

See CreateInstanceSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateInstances

func (c *Lightsail) CreateInstances(input *CreateInstancesInput) (*CreateInstancesOutput, error)

CreateInstances API operation for Amazon Lightsail.

Creates one or more Amazon Lightsail virtual private servers, or instances. Create instances using active blueprints. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Use the get blueprints operation to return a list of available blueprints.

The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateInstances for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstances

CreateInstancesFromSnapshot

func (c *Lightsail) CreateInstancesFromSnapshot(input *CreateInstancesFromSnapshotInput) (*CreateInstancesFromSnapshotOutput, error)

CreateInstancesFromSnapshot API operation for Amazon Lightsail.

Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.

The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instanceSnapshotName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateInstancesFromSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstancesFromSnapshot

CreateInstancesFromSnapshotRequest

func (c *Lightsail) CreateInstancesFromSnapshotRequest(input *CreateInstancesFromSnapshotInput) (req *request.Request, output *CreateInstancesFromSnapshotOutput)

CreateInstancesFromSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateInstancesFromSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateInstancesFromSnapshot for more information on using the CreateInstancesFromSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateInstancesFromSnapshotRequest method. req, resp := client.CreateInstancesFromSnapshotRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstancesFromSnapshot

CreateInstancesFromSnapshotWithContext

func (c *Lightsail) CreateInstancesFromSnapshotWithContext(ctx aws.Context, input *CreateInstancesFromSnapshotInput, opts ...request.Option) (*CreateInstancesFromSnapshotOutput, error)

CreateInstancesFromSnapshotWithContext is the same as CreateInstancesFromSnapshot with the addition of the ability to pass a context and additional request options.

See CreateInstancesFromSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateInstancesRequest

func (c *Lightsail) CreateInstancesRequest(input *CreateInstancesInput) (req *request.Request, output *CreateInstancesOutput)

CreateInstancesRequest generates a "aws/request.Request" representing the client's request for the CreateInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateInstances for more information on using the CreateInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateInstancesRequest method. req, resp := client.CreateInstancesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstances

CreateInstancesWithContext

func (c *Lightsail) CreateInstancesWithContext(ctx aws.Context, input *CreateInstancesInput, opts ...request.Option) (*CreateInstancesOutput, error)

CreateInstancesWithContext is the same as CreateInstances with the addition of the ability to pass a context and additional request options.

See CreateInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateKeyPair

func (c *Lightsail) CreateKeyPair(input *CreateKeyPairInput) (*CreateKeyPairOutput, error)

CreateKeyPair API operation for Amazon Lightsail.

Creates an SSH key pair.

The create key pair operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateKeyPair for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateKeyPair

CreateKeyPairRequest

func (c *Lightsail) CreateKeyPairRequest(input *CreateKeyPairInput) (req *request.Request, output *CreateKeyPairOutput)

CreateKeyPairRequest generates a "aws/request.Request" representing the client's request for the CreateKeyPair operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateKeyPair for more information on using the CreateKeyPair API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateKeyPairRequest method. req, resp := client.CreateKeyPairRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateKeyPair

CreateKeyPairWithContext

func (c *Lightsail) CreateKeyPairWithContext(ctx aws.Context, input *CreateKeyPairInput, opts ...request.Option) (*CreateKeyPairOutput, error)

CreateKeyPairWithContext is the same as CreateKeyPair with the addition of the ability to pass a context and additional request options.

See CreateKeyPair for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateLoadBalancer

func (c *Lightsail) CreateLoadBalancer(input *CreateLoadBalancerInput) (*CreateLoadBalancerOutput, error)

CreateLoadBalancer API operation for Amazon Lightsail.

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://lightsail.aws.amazon.com/ls/docs/how-to/article/configure-lightsail-instances-for-load-balancing). You can create up to 5 load balancers per AWS Region in your account.

When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation.

The create load balancer operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateLoadBalancer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancer

CreateLoadBalancerRequest

func (c *Lightsail) CreateLoadBalancerRequest(input *CreateLoadBalancerInput) (req *request.Request, output *CreateLoadBalancerOutput)

CreateLoadBalancerRequest generates a "aws/request.Request" representing the client's request for the CreateLoadBalancer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLoadBalancer for more information on using the CreateLoadBalancer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLoadBalancerRequest method. req, resp := client.CreateLoadBalancerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancer

CreateLoadBalancerTlsCertificate

func (c *Lightsail) CreateLoadBalancerTlsCertificate(input *CreateLoadBalancerTlsCertificateInput) (*CreateLoadBalancerTlsCertificateOutput, error)

CreateLoadBalancerTlsCertificate API operation for Amazon Lightsail.

Creates a Lightsail load balancer TLS certificate.

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

The create load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateLoadBalancerTlsCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancerTlsCertificate

CreateLoadBalancerTlsCertificateRequest

func (c *Lightsail) CreateLoadBalancerTlsCertificateRequest(input *CreateLoadBalancerTlsCertificateInput) (req *request.Request, output *CreateLoadBalancerTlsCertificateOutput)

CreateLoadBalancerTlsCertificateRequest generates a "aws/request.Request" representing the client's request for the CreateLoadBalancerTlsCertificate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLoadBalancerTlsCertificate for more information on using the CreateLoadBalancerTlsCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLoadBalancerTlsCertificateRequest method. req, resp := client.CreateLoadBalancerTlsCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancerTlsCertificate

CreateLoadBalancerTlsCertificateWithContext

func (c *Lightsail) CreateLoadBalancerTlsCertificateWithContext(ctx aws.Context, input *CreateLoadBalancerTlsCertificateInput, opts ...request.Option) (*CreateLoadBalancerTlsCertificateOutput, error)

CreateLoadBalancerTlsCertificateWithContext is the same as CreateLoadBalancerTlsCertificate with the addition of the ability to pass a context and additional request options.

See CreateLoadBalancerTlsCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateLoadBalancerWithContext

func (c *Lightsail) CreateLoadBalancerWithContext(ctx aws.Context, input *CreateLoadBalancerInput, opts ...request.Option) (*CreateLoadBalancerOutput, error)

CreateLoadBalancerWithContext is the same as CreateLoadBalancer with the addition of the ability to pass a context and additional request options.

See CreateLoadBalancer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateRelationalDatabase

func (c *Lightsail) CreateRelationalDatabase(input *CreateRelationalDatabaseInput) (*CreateRelationalDatabaseOutput, error)

CreateRelationalDatabase API operation for Amazon Lightsail.

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 Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateRelationalDatabase for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabase

CreateRelationalDatabaseFromSnapshot

func (c *Lightsail) CreateRelationalDatabaseFromSnapshot(input *CreateRelationalDatabaseFromSnapshotInput) (*CreateRelationalDatabaseFromSnapshotOutput, error)

CreateRelationalDatabaseFromSnapshot API operation for Amazon Lightsail.

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 Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateRelationalDatabaseFromSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshot

CreateRelationalDatabaseFromSnapshotRequest

func (c *Lightsail) CreateRelationalDatabaseFromSnapshotRequest(input *CreateRelationalDatabaseFromSnapshotInput) (req *request.Request, output *CreateRelationalDatabaseFromSnapshotOutput)

CreateRelationalDatabaseFromSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateRelationalDatabaseFromSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRelationalDatabaseFromSnapshot for more information on using the CreateRelationalDatabaseFromSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateRelationalDatabaseFromSnapshotRequest method. req, resp := client.CreateRelationalDatabaseFromSnapshotRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshot

CreateRelationalDatabaseFromSnapshotWithContext

func (c *Lightsail) CreateRelationalDatabaseFromSnapshotWithContext(ctx aws.Context, input *CreateRelationalDatabaseFromSnapshotInput, opts ...request.Option) (*CreateRelationalDatabaseFromSnapshotOutput, error)

CreateRelationalDatabaseFromSnapshotWithContext is the same as CreateRelationalDatabaseFromSnapshot with the addition of the ability to pass a context and additional request options.

See CreateRelationalDatabaseFromSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateRelationalDatabaseRequest

func (c *Lightsail) CreateRelationalDatabaseRequest(input *CreateRelationalDatabaseInput) (req *request.Request, output *CreateRelationalDatabaseOutput)

CreateRelationalDatabaseRequest generates a "aws/request.Request" representing the client's request for the CreateRelationalDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRelationalDatabase for more information on using the CreateRelationalDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateRelationalDatabaseRequest method. req, resp := client.CreateRelationalDatabaseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabase

CreateRelationalDatabaseSnapshot

func (c *Lightsail) CreateRelationalDatabaseSnapshot(input *CreateRelationalDatabaseSnapshotInput) (*CreateRelationalDatabaseSnapshotOutput, error)

CreateRelationalDatabaseSnapshot API operation for Amazon Lightsail.

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 Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateRelationalDatabaseSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseSnapshot

CreateRelationalDatabaseSnapshotRequest

func (c *Lightsail) CreateRelationalDatabaseSnapshotRequest(input *CreateRelationalDatabaseSnapshotInput) (req *request.Request, output *CreateRelationalDatabaseSnapshotOutput)

CreateRelationalDatabaseSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateRelationalDatabaseSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRelationalDatabaseSnapshot for more information on using the CreateRelationalDatabaseSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateRelationalDatabaseSnapshotRequest method. req, resp := client.CreateRelationalDatabaseSnapshotRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseSnapshot

CreateRelationalDatabaseSnapshotWithContext

func (c *Lightsail) CreateRelationalDatabaseSnapshotWithContext(ctx aws.Context, input *CreateRelationalDatabaseSnapshotInput, opts ...request.Option) (*CreateRelationalDatabaseSnapshotOutput, error)

CreateRelationalDatabaseSnapshotWithContext is the same as CreateRelationalDatabaseSnapshot with the addition of the ability to pass a context and additional request options.

See CreateRelationalDatabaseSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateRelationalDatabaseWithContext

func (c *Lightsail) CreateRelationalDatabaseWithContext(ctx aws.Context, input *CreateRelationalDatabaseInput, opts ...request.Option) (*CreateRelationalDatabaseOutput, error)

CreateRelationalDatabaseWithContext is the same as CreateRelationalDatabase with the addition of the ability to pass a context and additional request options.

See CreateRelationalDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteDisk

func (c *Lightsail) DeleteDisk(input *DeleteDiskInput) (*DeleteDiskOutput, error)

DeleteDisk API operation for Amazon Lightsail.

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.

The delete disk operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteDisk for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDisk

DeleteDiskRequest

func (c *Lightsail) DeleteDiskRequest(input *DeleteDiskInput) (req *request.Request, output *DeleteDiskOutput)

DeleteDiskRequest generates a "aws/request.Request" representing the client's request for the DeleteDisk operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDisk for more information on using the DeleteDisk API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDiskRequest method. req, resp := client.DeleteDiskRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDisk

DeleteDiskSnapshot

func (c *Lightsail) DeleteDiskSnapshot(input *DeleteDiskSnapshotInput) (*DeleteDiskSnapshotOutput, error)

DeleteDiskSnapshot API operation for Amazon Lightsail.

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 diskSnapshotName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteDiskSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDiskSnapshot

DeleteDiskSnapshotRequest

func (c *Lightsail) DeleteDiskSnapshotRequest(input *DeleteDiskSnapshotInput) (req *request.Request, output *DeleteDiskSnapshotOutput)

DeleteDiskSnapshotRequest generates a "aws/request.Request" representing the client's request for the DeleteDiskSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDiskSnapshot for more information on using the DeleteDiskSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDiskSnapshotRequest method. req, resp := client.DeleteDiskSnapshotRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDiskSnapshot

DeleteDiskSnapshotWithContext

func (c *Lightsail) DeleteDiskSnapshotWithContext(ctx aws.Context, input *DeleteDiskSnapshotInput, opts ...request.Option) (*DeleteDiskSnapshotOutput, error)

DeleteDiskSnapshotWithContext is the same as DeleteDiskSnapshot with the addition of the ability to pass a context and additional request options.

See DeleteDiskSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteDiskWithContext

func (c *Lightsail) DeleteDiskWithContext(ctx aws.Context, input *DeleteDiskInput, opts ...request.Option) (*DeleteDiskOutput, error)

DeleteDiskWithContext is the same as DeleteDisk with the addition of the ability to pass a context and additional request options.

See DeleteDisk for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteDomain

func (c *Lightsail) DeleteDomain(input *DeleteDomainInput) (*DeleteDomainOutput, error)

DeleteDomain API operation for Amazon Lightsail.

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 domainName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteDomain for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDomain

DeleteDomainEntry

func (c *Lightsail) DeleteDomainEntry(input *DeleteDomainEntryInput) (*DeleteDomainEntryOutput, error)

DeleteDomainEntry API operation for Amazon Lightsail.

Deletes a specific domain entry.

The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteDomainEntry for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDomainEntry

DeleteDomainEntryRequest

func (c *Lightsail) DeleteDomainEntryRequest(input *DeleteDomainEntryInput) (req *request.Request, output *DeleteDomainEntryOutput)

DeleteDomainEntryRequest generates a "aws/request.Request" representing the client's request for the DeleteDomainEntry operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDomainEntry for more information on using the DeleteDomainEntry API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDomainEntryRequest method. req, resp := client.DeleteDomainEntryRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDomainEntry

DeleteDomainEntryWithContext

func (c *Lightsail) DeleteDomainEntryWithContext(ctx aws.Context, input *DeleteDomainEntryInput, opts ...request.Option) (*DeleteDomainEntryOutput, error)

DeleteDomainEntryWithContext is the same as DeleteDomainEntry with the addition of the ability to pass a context and additional request options.

See DeleteDomainEntry for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteDomainRequest

func (c *Lightsail) DeleteDomainRequest(input *DeleteDomainInput) (req *request.Request, output *DeleteDomainOutput)

DeleteDomainRequest generates a "aws/request.Request" representing the client's request for the DeleteDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDomain for more information on using the DeleteDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDomainRequest method. req, resp := client.DeleteDomainRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDomain

DeleteDomainWithContext

func (c *Lightsail) DeleteDomainWithContext(ctx aws.Context, input *DeleteDomainInput, opts ...request.Option) (*DeleteDomainOutput, error)

DeleteDomainWithContext is the same as DeleteDomain with the addition of the ability to pass a context and additional request options.

See DeleteDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteInstance

func (c *Lightsail) DeleteInstance(input *DeleteInstanceInput) (*DeleteInstanceOutput, error)

DeleteInstance API operation for Amazon Lightsail.

Deletes a specific Amazon Lightsail virtual private server, or instance.

The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteInstance for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteInstance

DeleteInstanceRequest

func (c *Lightsail) DeleteInstanceRequest(input *DeleteInstanceInput) (req *request.Request, output *DeleteInstanceOutput)

DeleteInstanceRequest generates a "aws/request.Request" representing the client's request for the DeleteInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteInstance for more information on using the DeleteInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteInstanceRequest method. req, resp := client.DeleteInstanceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteInstance

DeleteInstanceSnapshot

func (c *Lightsail) DeleteInstanceSnapshot(input *DeleteInstanceSnapshotInput) (*DeleteInstanceSnapshotOutput, error)

DeleteInstanceSnapshot API operation for Amazon Lightsail.

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 instanceSnapshotName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteInstanceSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteInstanceSnapshot

DeleteInstanceSnapshotRequest

func (c *Lightsail) DeleteInstanceSnapshotRequest(input *DeleteInstanceSnapshotInput) (req *request.Request, output *DeleteInstanceSnapshotOutput)

DeleteInstanceSnapshotRequest generates a "aws/request.Request" representing the client's request for the DeleteInstanceSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteInstanceSnapshot for more information on using the DeleteInstanceSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteInstanceSnapshotRequest method. req, resp := client.DeleteInstanceSnapshotRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteInstanceSnapshot

DeleteInstanceSnapshotWithContext

func (c *Lightsail) DeleteInstanceSnapshotWithContext(ctx aws.Context, input *DeleteInstanceSnapshotInput, opts ...request.Option) (*DeleteInstanceSnapshotOutput, error)

DeleteInstanceSnapshotWithContext is the same as DeleteInstanceSnapshot with the addition of the ability to pass a context and additional request options.

See DeleteInstanceSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteInstanceWithContext

func (c *Lightsail) DeleteInstanceWithContext(ctx aws.Context, input *DeleteInstanceInput, opts ...request.Option) (*DeleteInstanceOutput, error)

DeleteInstanceWithContext is the same as DeleteInstance with the addition of the ability to pass a context and additional request options.

See DeleteInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteKeyPair

func (c *Lightsail) DeleteKeyPair(input *DeleteKeyPairInput) (*DeleteKeyPairOutput, error)

DeleteKeyPair API operation for Amazon Lightsail.

Deletes a specific SSH key pair.

The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by keyPairName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteKeyPair for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteKeyPair

DeleteKeyPairRequest

func (c *Lightsail) DeleteKeyPairRequest(input *DeleteKeyPairInput) (req *request.Request, output *DeleteKeyPairOutput)

DeleteKeyPairRequest generates a "aws/request.Request" representing the client's request for the DeleteKeyPair operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteKeyPair for more information on using the DeleteKeyPair API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteKeyPairRequest method. req, resp := client.DeleteKeyPairRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteKeyPair

DeleteKeyPairWithContext

func (c *Lightsail) DeleteKeyPairWithContext(ctx aws.Context, input *DeleteKeyPairInput, opts ...request.Option) (*DeleteKeyPairOutput, error)

DeleteKeyPairWithContext is the same as DeleteKeyPair with the addition of the ability to pass a context and additional request options.

See DeleteKeyPair for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteLoadBalancer

func (c *Lightsail) DeleteLoadBalancer(input *DeleteLoadBalancerInput) (*DeleteLoadBalancerOutput, error)

DeleteLoadBalancer API operation for Amazon Lightsail.

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 loadBalancerName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteLoadBalancer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancer

DeleteLoadBalancerRequest

func (c *Lightsail) DeleteLoadBalancerRequest(input *DeleteLoadBalancerInput) (req *request.Request, output *DeleteLoadBalancerOutput)

DeleteLoadBalancerRequest generates a "aws/request.Request" representing the client's request for the DeleteLoadBalancer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLoadBalancer for more information on using the DeleteLoadBalancer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLoadBalancerRequest method. req, resp := client.DeleteLoadBalancerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancer

DeleteLoadBalancerTlsCertificate

func (c *Lightsail) DeleteLoadBalancerTlsCertificate(input *DeleteLoadBalancerTlsCertificateInput) (*DeleteLoadBalancerTlsCertificateOutput, error)

DeleteLoadBalancerTlsCertificate API operation for Amazon Lightsail.

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

The delete load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteLoadBalancerTlsCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificate

DeleteLoadBalancerTlsCertificateRequest

func (c *Lightsail) DeleteLoadBalancerTlsCertificateRequest(input *DeleteLoadBalancerTlsCertificateInput) (req *request.Request, output *DeleteLoadBalancerTlsCertificateOutput)

DeleteLoadBalancerTlsCertificateRequest generates a "aws/request.Request" representing the client's request for the DeleteLoadBalancerTlsCertificate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLoadBalancerTlsCertificate for more information on using the DeleteLoadBalancerTlsCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLoadBalancerTlsCertificateRequest method. req, resp := client.DeleteLoadBalancerTlsCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificate

DeleteLoadBalancerTlsCertificateWithContext

func (c *Lightsail) DeleteLoadBalancerTlsCertificateWithContext(ctx aws.Context, input *DeleteLoadBalancerTlsCertificateInput, opts ...request.Option) (*DeleteLoadBalancerTlsCertificateOutput, error)

DeleteLoadBalancerTlsCertificateWithContext is the same as DeleteLoadBalancerTlsCertificate with the addition of the ability to pass a context and additional request options.

See DeleteLoadBalancerTlsCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteLoadBalancerWithContext

func (c *Lightsail) DeleteLoadBalancerWithContext(ctx aws.Context, input *DeleteLoadBalancerInput, opts ...request.Option) (*DeleteLoadBalancerOutput, error)

DeleteLoadBalancerWithContext is the same as DeleteLoadBalancer with the addition of the ability to pass a context and additional request options.

See DeleteLoadBalancer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteRelationalDatabase

func (c *Lightsail) DeleteRelationalDatabase(input *DeleteRelationalDatabaseInput) (*DeleteRelationalDatabaseOutput, error)

DeleteRelationalDatabase API operation for Amazon Lightsail.

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 Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteRelationalDatabase for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabase

DeleteRelationalDatabaseRequest

func (c *Lightsail) DeleteRelationalDatabaseRequest(input *DeleteRelationalDatabaseInput) (req *request.Request, output *DeleteRelationalDatabaseOutput)

DeleteRelationalDatabaseRequest generates a "aws/request.Request" representing the client's request for the DeleteRelationalDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRelationalDatabase for more information on using the DeleteRelationalDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRelationalDatabaseRequest method. req, resp := client.DeleteRelationalDatabaseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabase

DeleteRelationalDatabaseSnapshot

func (c *Lightsail) DeleteRelationalDatabaseSnapshot(input *DeleteRelationalDatabaseSnapshotInput) (*DeleteRelationalDatabaseSnapshotOutput, error)

DeleteRelationalDatabaseSnapshot API operation for Amazon Lightsail.

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 Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteRelationalDatabaseSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshot

DeleteRelationalDatabaseSnapshotRequest

func (c *Lightsail) DeleteRelationalDatabaseSnapshotRequest(input *DeleteRelationalDatabaseSnapshotInput) (req *request.Request, output *DeleteRelationalDatabaseSnapshotOutput)

DeleteRelationalDatabaseSnapshotRequest generates a "aws/request.Request" representing the client's request for the DeleteRelationalDatabaseSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRelationalDatabaseSnapshot for more information on using the DeleteRelationalDatabaseSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRelationalDatabaseSnapshotRequest method. req, resp := client.DeleteRelationalDatabaseSnapshotRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshot

DeleteRelationalDatabaseSnapshotWithContext

func (c *Lightsail) DeleteRelationalDatabaseSnapshotWithContext(ctx aws.Context, input *DeleteRelationalDatabaseSnapshotInput, opts ...request.Option) (*DeleteRelationalDatabaseSnapshotOutput, error)

DeleteRelationalDatabaseSnapshotWithContext is the same as DeleteRelationalDatabaseSnapshot with the addition of the ability to pass a context and additional request options.

See DeleteRelationalDatabaseSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteRelationalDatabaseWithContext

func (c *Lightsail) DeleteRelationalDatabaseWithContext(ctx aws.Context, input *DeleteRelationalDatabaseInput, opts ...request.Option) (*DeleteRelationalDatabaseOutput, error)

DeleteRelationalDatabaseWithContext is the same as DeleteRelationalDatabase with the addition of the ability to pass a context and additional request options.

See DeleteRelationalDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DetachDisk

func (c *Lightsail) DetachDisk(input *DetachDiskInput) (*DetachDiskOutput, error)

DetachDisk API operation for Amazon Lightsail.

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 diskName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DetachDisk for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachDisk

DetachDiskRequest

func (c *Lightsail) DetachDiskRequest(input *DetachDiskInput) (req *request.Request, output *DetachDiskOutput)

DetachDiskRequest generates a "aws/request.Request" representing the client's request for the DetachDisk operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachDisk for more information on using the DetachDisk API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetachDiskRequest method. req, resp := client.DetachDiskRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachDisk

DetachDiskWithContext

func (c *Lightsail) DetachDiskWithContext(ctx aws.Context, input *DetachDiskInput, opts ...request.Option) (*DetachDiskOutput, error)

DetachDiskWithContext is the same as DetachDisk with the addition of the ability to pass a context and additional request options.

See DetachDisk for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DetachInstancesFromLoadBalancer

func (c *Lightsail) DetachInstancesFromLoadBalancer(input *DetachInstancesFromLoadBalancerInput) (*DetachInstancesFromLoadBalancerOutput, error)

DetachInstancesFromLoadBalancer API operation for Amazon Lightsail.

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 loadBalancerName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DetachInstancesFromLoadBalancer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachInstancesFromLoadBalancer

DetachInstancesFromLoadBalancerRequest

func (c *Lightsail) DetachInstancesFromLoadBalancerRequest(input *DetachInstancesFromLoadBalancerInput) (req *request.Request, output *DetachInstancesFromLoadBalancerOutput)

DetachInstancesFromLoadBalancerRequest generates a "aws/request.Request" representing the client's request for the DetachInstancesFromLoadBalancer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachInstancesFromLoadBalancer for more information on using the DetachInstancesFromLoadBalancer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetachInstancesFromLoadBalancerRequest method. req, resp := client.DetachInstancesFromLoadBalancerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachInstancesFromLoadBalancer

DetachInstancesFromLoadBalancerWithContext

func (c *Lightsail) DetachInstancesFromLoadBalancerWithContext(ctx aws.Context, input *DetachInstancesFromLoadBalancerInput, opts ...request.Option) (*DetachInstancesFromLoadBalancerOutput, error)

DetachInstancesFromLoadBalancerWithContext is the same as DetachInstancesFromLoadBalancer with the addition of the ability to pass a context and additional request options.

See DetachInstancesFromLoadBalancer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DetachStaticIp

func (c *Lightsail) DetachStaticIp(input *DetachStaticIpInput) (*DetachStaticIpOutput, error)

DetachStaticIp API operation for Amazon Lightsail.

Detaches a static IP from the Amazon Lightsail instance to which it is attached.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DetachStaticIp for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachStaticIp

DetachStaticIpRequest

func (c *Lightsail) DetachStaticIpRequest(input *DetachStaticIpInput) (req *request.Request, output *DetachStaticIpOutput)

DetachStaticIpRequest generates a "aws/request.Request" representing the client's request for the DetachStaticIp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachStaticIp for more information on using the DetachStaticIp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetachStaticIpRequest method. req, resp := client.DetachStaticIpRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachStaticIp

DetachStaticIpWithContext

func (c *Lightsail) DetachStaticIpWithContext(ctx aws.Context, input *DetachStaticIpInput, opts ...request.Option) (*DetachStaticIpOutput, error)

DetachStaticIpWithContext is the same as DetachStaticIp with the addition of the ability to pass a context and additional request options.

See DetachStaticIp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DownloadDefaultKeyPair

func (c *Lightsail) DownloadDefaultKeyPair(input *DownloadDefaultKeyPairInput) (*DownloadDefaultKeyPairOutput, error)

DownloadDefaultKeyPair API operation for Amazon Lightsail.

Downloads the default SSH key pair from the user's account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DownloadDefaultKeyPair for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DownloadDefaultKeyPair

DownloadDefaultKeyPairRequest

func (c *Lightsail) DownloadDefaultKeyPairRequest(input *DownloadDefaultKeyPairInput) (req *request.Request, output *DownloadDefaultKeyPairOutput)

DownloadDefaultKeyPairRequest generates a "aws/request.Request" representing the client's request for the DownloadDefaultKeyPair operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DownloadDefaultKeyPair for more information on using the DownloadDefaultKeyPair API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DownloadDefaultKeyPairRequest method. req, resp := client.DownloadDefaultKeyPairRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DownloadDefaultKeyPair

DownloadDefaultKeyPairWithContext

func (c *Lightsail) DownloadDefaultKeyPairWithContext(ctx aws.Context, input *DownloadDefaultKeyPairInput, opts ...request.Option) (*DownloadDefaultKeyPairOutput, error)

DownloadDefaultKeyPairWithContext is the same as DownloadDefaultKeyPair with the addition of the ability to pass a context and additional request options.

See DownloadDefaultKeyPair for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ExportSnapshot

func (c *Lightsail) ExportSnapshot(input *ExportSnapshotInput) (*ExportSnapshotOutput, error)

ExportSnapshot API operation for Amazon Lightsail.

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 snapshotoperation supports tag-based access control via resource tags applied to the resource identified by sourceSnapshotName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation ExportSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ExportSnapshot

ExportSnapshotRequest

func (c *Lightsail) ExportSnapshotRequest(input *ExportSnapshotInput) (req *request.Request, output *ExportSnapshotOutput)

ExportSnapshotRequest generates a "aws/request.Request" representing the client's request for the ExportSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExportSnapshot for more information on using the ExportSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ExportSnapshotRequest method. req, resp := client.ExportSnapshotRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ExportSnapshot

ExportSnapshotWithContext

func (c *Lightsail) ExportSnapshotWithContext(ctx aws.Context, input *ExportSnapshotInput, opts ...request.Option) (*ExportSnapshotOutput, error)

ExportSnapshotWithContext is the same as ExportSnapshot with the addition of the ability to pass a context and additional request options.

See ExportSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetActiveNames

func (c *Lightsail) GetActiveNames(input *GetActiveNamesInput) (*GetActiveNamesOutput, error)

GetActiveNames API operation for Amazon Lightsail.

Returns the names of all active (not deleted) resources.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetActiveNames for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetActiveNames

GetActiveNamesRequest

func (c *Lightsail) GetActiveNamesRequest(input *GetActiveNamesInput) (req *request.Request, output *GetActiveNamesOutput)

GetActiveNamesRequest generates a "aws/request.Request" representing the client's request for the GetActiveNames operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetActiveNames for more information on using the GetActiveNames API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetActiveNamesRequest method. req, resp := client.GetActiveNamesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetActiveNames

GetActiveNamesWithContext

func (c *Lightsail) GetActiveNamesWithContext(ctx aws.Context, input *GetActiveNamesInput, opts ...request.Option) (*GetActiveNamesOutput, error)

GetActiveNamesWithContext is the same as GetActiveNames with the addition of the ability to pass a context and additional request options.

See GetActiveNames for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetBlueprints

func (c *Lightsail) GetBlueprints(input *GetBlueprintsInput) (*GetBlueprintsOutput, error)

GetBlueprints API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetBlueprints for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBlueprints

GetBlueprintsRequest

func (c *Lightsail) GetBlueprintsRequest(input *GetBlueprintsInput) (req *request.Request, output *GetBlueprintsOutput)

GetBlueprintsRequest generates a "aws/request.Request" representing the client's request for the GetBlueprints operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBlueprints for more information on using the GetBlueprints API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetBlueprintsRequest method. req, resp := client.GetBlueprintsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBlueprints

GetBlueprintsWithContext

func (c *Lightsail) GetBlueprintsWithContext(ctx aws.Context, input *GetBlueprintsInput, opts ...request.Option) (*GetBlueprintsOutput, error)

GetBlueprintsWithContext is the same as GetBlueprints with the addition of the ability to pass a context and additional request options.

See GetBlueprints for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetBundles

func (c *Lightsail) GetBundles(input *GetBundlesInput) (*GetBundlesOutput, error)

GetBundles API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetBundles for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBundles

GetBundlesRequest

func (c *Lightsail) GetBundlesRequest(input *GetBundlesInput) (req *request.Request, output *GetBundlesOutput)

GetBundlesRequest generates a "aws/request.Request" representing the client's request for the GetBundles operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBundles for more information on using the GetBundles API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetBundlesRequest method. req, resp := client.GetBundlesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBundles

GetBundlesWithContext

func (c *Lightsail) GetBundlesWithContext(ctx aws.Context, input *GetBundlesInput, opts ...request.Option) (*GetBundlesOutput, error)

GetBundlesWithContext is the same as GetBundles with the addition of the ability to pass a context and additional request options.

See GetBundles for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetCloudFormationStackRecords

func (c *Lightsail) GetCloudFormationStackRecords(input *GetCloudFormationStackRecordsInput) (*GetCloudFormationStackRecordsOutput, error)

GetCloudFormationStackRecords API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetCloudFormationStackRecords for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetCloudFormationStackRecords

GetCloudFormationStackRecordsRequest

func (c *Lightsail) GetCloudFormationStackRecordsRequest(input *GetCloudFormationStackRecordsInput) (req *request.Request, output *GetCloudFormationStackRecordsOutput)

GetCloudFormationStackRecordsRequest generates a "aws/request.Request" representing the client's request for the GetCloudFormationStackRecords operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCloudFormationStackRecords for more information on using the GetCloudFormationStackRecords API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetCloudFormationStackRecordsRequest method. req, resp := client.GetCloudFormationStackRecordsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetCloudFormationStackRecords

GetCloudFormationStackRecordsWithContext

func (c *Lightsail) GetCloudFormationStackRecordsWithContext(ctx aws.Context, input *GetCloudFormationStackRecordsInput, opts ...request.Option) (*GetCloudFormationStackRecordsOutput, error)

GetCloudFormationStackRecordsWithContext is the same as GetCloudFormationStackRecords with the addition of the ability to pass a context and additional request options.

See GetCloudFormationStackRecords for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetDisk

func (c *Lightsail) GetDisk(input *GetDiskInput) (*GetDiskOutput, error)

GetDisk API operation for Amazon Lightsail.

Returns information about a specific block storage disk.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetDisk for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDisk

GetDiskRequest

func (c *Lightsail) GetDiskRequest(input *GetDiskInput) (req *request.Request, output *GetDiskOutput)

GetDiskRequest generates a "aws/request.Request" representing the client's request for the GetDisk operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDisk for more information on using the GetDisk API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDiskRequest method. req, resp := client.GetDiskRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDisk

GetDiskSnapshot

func (c *Lightsail) GetDiskSnapshot(input *GetDiskSnapshotInput) (*GetDiskSnapshotOutput, error)

GetDiskSnapshot API operation for Amazon Lightsail.

Returns information about a specific block storage disk snapshot.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetDiskSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskSnapshot

GetDiskSnapshotRequest

func (c *Lightsail) GetDiskSnapshotRequest(input *GetDiskSnapshotInput) (req *request.Request, output *GetDiskSnapshotOutput)

GetDiskSnapshotRequest generates a "aws/request.Request" representing the client's request for the GetDiskSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDiskSnapshot for more information on using the GetDiskSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDiskSnapshotRequest method. req, resp := client.GetDiskSnapshotRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskSnapshot

GetDiskSnapshotWithContext

func (c *Lightsail) GetDiskSnapshotWithContext(ctx aws.Context, input *GetDiskSnapshotInput, opts ...request.Option) (*GetDiskSnapshotOutput, error)

GetDiskSnapshotWithContext is the same as GetDiskSnapshot with the addition of the ability to pass a context and additional request options.

See GetDiskSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetDiskSnapshots

func (c *Lightsail) GetDiskSnapshots(input *GetDiskSnapshotsInput) (*GetDiskSnapshotsOutput, error)

GetDiskSnapshots API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetDiskSnapshots for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskSnapshots

GetDiskSnapshotsRequest

func (c *Lightsail) GetDiskSnapshotsRequest(input *GetDiskSnapshotsInput) (req *request.Request, output *GetDiskSnapshotsOutput)

GetDiskSnapshotsRequest generates a "aws/request.Request" representing the client's request for the GetDiskSnapshots operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDiskSnapshots for more information on using the GetDiskSnapshots API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDiskSnapshotsRequest method. req, resp := client.GetDiskSnapshotsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskSnapshots

GetDiskSnapshotsWithContext

func (c *Lightsail) GetDiskSnapshotsWithContext(ctx aws.Context, input *GetDiskSnapshotsInput, opts ...request.Option) (*GetDiskSnapshotsOutput, error)

GetDiskSnapshotsWithContext is the same as GetDiskSnapshots with the addition of the ability to pass a context and additional request options.

See GetDiskSnapshots for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetDiskWithContext

func (c *Lightsail) GetDiskWithContext(ctx aws.Context, input *GetDiskInput, opts ...request.Option) (*GetDiskOutput, error)

GetDiskWithContext is the same as GetDisk with the addition of the ability to pass a context and additional request options.

See GetDisk for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetDisks

func (c *Lightsail) GetDisks(input *GetDisksInput) (*GetDisksOutput, error)

GetDisks API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetDisks for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDisks

GetDisksRequest

func (c *Lightsail) GetDisksRequest(input *GetDisksInput) (req *request.Request, output *GetDisksOutput)

GetDisksRequest generates a "aws/request.Request" representing the client's request for the GetDisks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDisks for more information on using the GetDisks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDisksRequest method. req, resp := client.GetDisksRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDisks

GetDisksWithContext

func (c *Lightsail) GetDisksWithContext(ctx aws.Context, input *GetDisksInput, opts ...request.Option) (*GetDisksOutput, error)

GetDisksWithContext is the same as GetDisks with the addition of the ability to pass a context and additional request options.

See GetDisks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetDomain

func (c *Lightsail) GetDomain(input *GetDomainInput) (*GetDomainOutput, error)

GetDomain API operation for Amazon Lightsail.

Returns information about a specific domain recordset.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetDomain for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDomain

GetDomainRequest

func (c *Lightsail) GetDomainRequest(input *GetDomainInput) (req *request.Request, output *GetDomainOutput)

GetDomainRequest generates a "aws/request.Request" representing the client's request for the GetDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDomain for more information on using the GetDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDomainRequest method. req, resp := client.GetDomainRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDomain

GetDomainWithContext

func (c *Lightsail) GetDomainWithContext(ctx aws.Context, input *GetDomainInput, opts ...request.Option) (*GetDomainOutput, error)

GetDomainWithContext is the same as GetDomain with the addition of the ability to pass a context and additional request options.

See GetDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetDomains

func (c *Lightsail) GetDomains(input *GetDomainsInput) (*GetDomainsOutput, error)

GetDomains API operation for Amazon Lightsail.

Returns a list of all domains in the user's account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetDomains for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDomains

GetDomainsRequest

func (c *Lightsail) GetDomainsRequest(input *GetDomainsInput) (req *request.Request, output *GetDomainsOutput)

GetDomainsRequest generates a "aws/request.Request" representing the client's request for the GetDomains operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDomains for more information on using the GetDomains API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDomainsRequest method. req, resp := client.GetDomainsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDomains

GetDomainsWithContext

func (c *Lightsail) GetDomainsWithContext(ctx aws.Context, input *GetDomainsInput, opts ...request.Option) (*GetDomainsOutput, error)

GetDomainsWithContext is the same as GetDomains with the addition of the ability to pass a context and additional request options.

See GetDomains for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetExportSnapshotRecords

func (c *Lightsail) GetExportSnapshotRecords(input *GetExportSnapshotRecordsInput) (*GetExportSnapshotRecordsOutput, error)

GetExportSnapshotRecords API operation for Amazon Lightsail.

Returns the export snapshot record 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 create cloud formation stack operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetExportSnapshotRecords for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetExportSnapshotRecords

GetExportSnapshotRecordsRequest

func (c *Lightsail) GetExportSnapshotRecordsRequest(input *GetExportSnapshotRecordsInput) (req *request.Request, output *GetExportSnapshotRecordsOutput)

GetExportSnapshotRecordsRequest generates a "aws/request.Request" representing the client's request for the GetExportSnapshotRecords operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetExportSnapshotRecords for more information on using the GetExportSnapshotRecords API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetExportSnapshotRecordsRequest method. req, resp := client.GetExportSnapshotRecordsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetExportSnapshotRecords

GetExportSnapshotRecordsWithContext

func (c *Lightsail) GetExportSnapshotRecordsWithContext(ctx aws.Context, input *GetExportSnapshotRecordsInput, opts ...request.Option) (*GetExportSnapshotRecordsOutput, error)

GetExportSnapshotRecordsWithContext is the same as GetExportSnapshotRecords with the addition of the ability to pass a context and additional request options.

See GetExportSnapshotRecords for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetInstance

func (c *Lightsail) GetInstance(input *GetInstanceInput) (*GetInstanceOutput, error)

GetInstance API operation for Amazon Lightsail.

Returns information about a specific Amazon Lightsail instance, which is a virtual private server.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstance for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstance

GetInstanceAccessDetails

func (c *Lightsail) GetInstanceAccessDetails(input *GetInstanceAccessDetailsInput) (*GetInstanceAccessDetailsOutput, error)

GetInstanceAccessDetails API operation for Amazon Lightsail.

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 instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstanceAccessDetails for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceAccessDetails

GetInstanceAccessDetailsRequest

func (c *Lightsail) GetInstanceAccessDetailsRequest(input *GetInstanceAccessDetailsInput) (req *request.Request, output *GetInstanceAccessDetailsOutput)

GetInstanceAccessDetailsRequest generates a "aws/request.Request" representing the client's request for the GetInstanceAccessDetails operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstanceAccessDetails for more information on using the GetInstanceAccessDetails API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstanceAccessDetailsRequest method. req, resp := client.GetInstanceAccessDetailsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceAccessDetails

GetInstanceAccessDetailsWithContext

func (c *Lightsail) GetInstanceAccessDetailsWithContext(ctx aws.Context, input *GetInstanceAccessDetailsInput, opts ...request.Option) (*GetInstanceAccessDetailsOutput, error)

GetInstanceAccessDetailsWithContext is the same as GetInstanceAccessDetails with the addition of the ability to pass a context and additional request options.

See GetInstanceAccessDetails for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetInstanceMetricData

func (c *Lightsail) GetInstanceMetricData(input *GetInstanceMetricDataInput) (*GetInstanceMetricDataOutput, error)

GetInstanceMetricData API operation for Amazon Lightsail.

Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstanceMetricData for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceMetricData

GetInstanceMetricDataRequest

func (c *Lightsail) GetInstanceMetricDataRequest(input *GetInstanceMetricDataInput) (req *request.Request, output *GetInstanceMetricDataOutput)

GetInstanceMetricDataRequest generates a "aws/request.Request" representing the client's request for the GetInstanceMetricData operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstanceMetricData for more information on using the GetInstanceMetricData API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstanceMetricDataRequest method. req, resp := client.GetInstanceMetricDataRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceMetricData

GetInstanceMetricDataWithContext

func (c *Lightsail) GetInstanceMetricDataWithContext(ctx aws.Context, input *GetInstanceMetricDataInput, opts ...request.Option) (*GetInstanceMetricDataOutput, error)

GetInstanceMetricDataWithContext is the same as GetInstanceMetricData with the addition of the ability to pass a context and additional request options.

See GetInstanceMetricData for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetInstancePortStates

func (c *Lightsail) GetInstancePortStates(input *GetInstancePortStatesInput) (*GetInstancePortStatesOutput, error)

GetInstancePortStates API operation for Amazon Lightsail.

Returns the port states for a specific virtual private server, or instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstancePortStates for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstancePortStates

GetInstancePortStatesRequest

func (c *Lightsail) GetInstancePortStatesRequest(input *GetInstancePortStatesInput) (req *request.Request, output *GetInstancePortStatesOutput)

GetInstancePortStatesRequest generates a "aws/request.Request" representing the client's request for the GetInstancePortStates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstancePortStates for more information on using the GetInstancePortStates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstancePortStatesRequest method. req, resp := client.GetInstancePortStatesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstancePortStates

GetInstancePortStatesWithContext

func (c *Lightsail) GetInstancePortStatesWithContext(ctx aws.Context, input *GetInstancePortStatesInput, opts ...request.Option) (*GetInstancePortStatesOutput, error)

GetInstancePortStatesWithContext is the same as GetInstancePortStates with the addition of the ability to pass a context and additional request options.

See GetInstancePortStates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetInstanceRequest

func (c *Lightsail) GetInstanceRequest(input *GetInstanceInput) (req *request.Request, output *GetInstanceOutput)

GetInstanceRequest generates a "aws/request.Request" representing the client's request for the GetInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstance for more information on using the GetInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstanceRequest method. req, resp := client.GetInstanceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstance

GetInstanceSnapshot

func (c *Lightsail) GetInstanceSnapshot(input *GetInstanceSnapshotInput) (*GetInstanceSnapshotOutput, error)

GetInstanceSnapshot API operation for Amazon Lightsail.

Returns information about a specific instance snapshot.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstanceSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceSnapshot

GetInstanceSnapshotRequest

func (c *Lightsail) GetInstanceSnapshotRequest(input *GetInstanceSnapshotInput) (req *request.Request, output *GetInstanceSnapshotOutput)

GetInstanceSnapshotRequest generates a "aws/request.Request" representing the client's request for the GetInstanceSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstanceSnapshot for more information on using the GetInstanceSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstanceSnapshotRequest method. req, resp := client.GetInstanceSnapshotRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceSnapshot

GetInstanceSnapshotWithContext

func (c *Lightsail) GetInstanceSnapshotWithContext(ctx aws.Context, input *GetInstanceSnapshotInput, opts ...request.Option) (*GetInstanceSnapshotOutput, error)

GetInstanceSnapshotWithContext is the same as GetInstanceSnapshot with the addition of the ability to pass a context and additional request options.

See GetInstanceSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetInstanceSnapshots

func (c *Lightsail) GetInstanceSnapshots(input *GetInstanceSnapshotsInput) (*GetInstanceSnapshotsOutput, error)

GetInstanceSnapshots API operation for Amazon Lightsail.

Returns all instance snapshots for the user's account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstanceSnapshots for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceSnapshots

GetInstanceSnapshotsRequest

func (c *Lightsail) GetInstanceSnapshotsRequest(input *GetInstanceSnapshotsInput) (req *request.Request, output *GetInstanceSnapshotsOutput)

GetInstanceSnapshotsRequest generates a "aws/request.Request" representing the client's request for the GetInstanceSnapshots operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstanceSnapshots for more information on using the GetInstanceSnapshots API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstanceSnapshotsRequest method. req, resp := client.GetInstanceSnapshotsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceSnapshots

GetInstanceSnapshotsWithContext

func (c *Lightsail) GetInstanceSnapshotsWithContext(ctx aws.Context, input *GetInstanceSnapshotsInput, opts ...request.Option) (*GetInstanceSnapshotsOutput, error)

GetInstanceSnapshotsWithContext is the same as GetInstanceSnapshots with the addition of the ability to pass a context and additional request options.

See GetInstanceSnapshots for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetInstanceState

func (c *Lightsail) GetInstanceState(input *GetInstanceStateInput) (*GetInstanceStateOutput, error)

GetInstanceState API operation for Amazon Lightsail.

Returns the state of a specific instance. Works on one instance at a time.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstanceState for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceState

GetInstanceStateRequest

func (c *Lightsail) GetInstanceStateRequest(input *GetInstanceStateInput) (req *request.Request, output *GetInstanceStateOutput)

GetInstanceStateRequest generates a "aws/request.Request" representing the client's request for the GetInstanceState operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstanceState for more information on using the GetInstanceState API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstanceStateRequest method. req, resp := client.GetInstanceStateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceState

GetInstanceStateWithContext

func (c *Lightsail) GetInstanceStateWithContext(ctx aws.Context, input *GetInstanceStateInput, opts ...request.Option) (*GetInstanceStateOutput, error)

GetInstanceStateWithContext is the same as GetInstanceState with the addition of the ability to pass a context and additional request options.

See GetInstanceState for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetInstanceWithContext

func (c *Lightsail) GetInstanceWithContext(ctx aws.Context, input *GetInstanceInput, opts ...request.Option) (*GetInstanceOutput, error)

GetInstanceWithContext is the same as GetInstance with the addition of the ability to pass a context and additional request options.

See GetInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetInstances

func (c *Lightsail) GetInstances(input *GetInstancesInput) (*GetInstancesOutput, error)

GetInstances API operation for Amazon Lightsail.

Returns information about all Amazon Lightsail virtual private servers, or instances.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstances for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstances

GetInstancesRequest

func (c *Lightsail) GetInstancesRequest(input *GetInstancesInput) (req *request.Request, output *GetInstancesOutput)

GetInstancesRequest generates a "aws/request.Request" representing the client's request for the GetInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstances for more information on using the GetInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstancesRequest method. req, resp := client.GetInstancesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstances

GetInstancesWithContext

func (c *Lightsail) GetInstancesWithContext(ctx aws.Context, input *GetInstancesInput, opts ...request.Option) (*GetInstancesOutput, error)

GetInstancesWithContext is the same as GetInstances with the addition of the ability to pass a context and additional request options.

See GetInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetKeyPair

func (c *Lightsail) GetKeyPair(input *GetKeyPairInput) (*GetKeyPairOutput, error)

GetKeyPair API operation for Amazon Lightsail.

Returns information about a specific key pair.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetKeyPair for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetKeyPair

GetKeyPairRequest

func (c *Lightsail) GetKeyPairRequest(input *GetKeyPairInput) (req *request.Request, output *GetKeyPairOutput)

GetKeyPairRequest generates a "aws/request.Request" representing the client's request for the GetKeyPair operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetKeyPair for more information on using the GetKeyPair API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetKeyPairRequest method. req, resp := client.GetKeyPairRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetKeyPair

GetKeyPairWithContext

func (c *Lightsail) GetKeyPairWithContext(ctx aws.Context, input *GetKeyPairInput, opts ...request.Option) (*GetKeyPairOutput, error)

GetKeyPairWithContext is the same as GetKeyPair with the addition of the ability to pass a context and additional request options.

See GetKeyPair for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetKeyPairs

func (c *Lightsail) GetKeyPairs(input *GetKeyPairsInput) (*GetKeyPairsOutput, error)

GetKeyPairs API operation for Amazon Lightsail.

Returns information about all key pairs in the user's account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetKeyPairs for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetKeyPairs

GetKeyPairsRequest

func (c *Lightsail) GetKeyPairsRequest(input *GetKeyPairsInput) (req *request.Request, output *GetKeyPairsOutput)

GetKeyPairsRequest generates a "aws/request.Request" representing the client's request for the GetKeyPairs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetKeyPairs for more information on using the GetKeyPairs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetKeyPairsRequest method. req, resp := client.GetKeyPairsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetKeyPairs

GetKeyPairsWithContext

func (c *Lightsail) GetKeyPairsWithContext(ctx aws.Context, input *GetKeyPairsInput, opts ...request.Option) (*GetKeyPairsOutput, error)

GetKeyPairsWithContext is the same as GetKeyPairs with the addition of the ability to pass a context and additional request options.

See GetKeyPairs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetLoadBalancer

func (c *Lightsail) GetLoadBalancer(input *GetLoadBalancerInput) (*GetLoadBalancerOutput, error)

GetLoadBalancer API operation for Amazon Lightsail.

Returns information about the specified Lightsail load balancer.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetLoadBalancer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancer

GetLoadBalancerMetricData

func (c *Lightsail) GetLoadBalancerMetricData(input *GetLoadBalancerMetricDataInput) (*GetLoadBalancerMetricDataOutput, error)

GetLoadBalancerMetricData API operation for Amazon Lightsail.

Returns information about health metrics for your Lightsail load balancer.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetLoadBalancerMetricData for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerMetricData

GetLoadBalancerMetricDataRequest

func (c *Lightsail) GetLoadBalancerMetricDataRequest(input *GetLoadBalancerMetricDataInput) (req *request.Request, output *GetLoadBalancerMetricDataOutput)

GetLoadBalancerMetricDataRequest generates a "aws/request.Request" representing the client's request for the GetLoadBalancerMetricData operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLoadBalancerMetricData for more information on using the GetLoadBalancerMetricData API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLoadBalancerMetricDataRequest method. req, resp := client.GetLoadBalancerMetricDataRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerMetricData

GetLoadBalancerMetricDataWithContext

func (c *Lightsail) GetLoadBalancerMetricDataWithContext(ctx aws.Context, input *GetLoadBalancerMetricDataInput, opts ...request.Option) (*GetLoadBalancerMetricDataOutput, error)

GetLoadBalancerMetricDataWithContext is the same as GetLoadBalancerMetricData with the addition of the ability to pass a context and additional request options.

See GetLoadBalancerMetricData for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetLoadBalancerRequest

func (c *Lightsail) GetLoadBalancerRequest(input *GetLoadBalancerInput) (req *request.Request, output *GetLoadBalancerOutput)

GetLoadBalancerRequest generates a "aws/request.Request" representing the client's request for the GetLoadBalancer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLoadBalancer for more information on using the GetLoadBalancer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLoadBalancerRequest method. req, resp := client.GetLoadBalancerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancer

GetLoadBalancerTlsCertificates

func (c *Lightsail) GetLoadBalancerTlsCertificates(input *GetLoadBalancerTlsCertificatesInput) (*GetLoadBalancerTlsCertificatesOutput, error)

GetLoadBalancerTlsCertificates API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetLoadBalancerTlsCertificates for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerTlsCertificates

GetLoadBalancerTlsCertificatesRequest

func (c *Lightsail) GetLoadBalancerTlsCertificatesRequest(input *GetLoadBalancerTlsCertificatesInput) (req *request.Request, output *GetLoadBalancerTlsCertificatesOutput)

GetLoadBalancerTlsCertificatesRequest generates a "aws/request.Request" representing the client's request for the GetLoadBalancerTlsCertificates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLoadBalancerTlsCertificates for more information on using the GetLoadBalancerTlsCertificates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLoadBalancerTlsCertificatesRequest method. req, resp := client.GetLoadBalancerTlsCertificatesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerTlsCertificates

GetLoadBalancerTlsCertificatesWithContext

func (c *Lightsail) GetLoadBalancerTlsCertificatesWithContext(ctx aws.Context, input *GetLoadBalancerTlsCertificatesInput, opts ...request.Option) (*GetLoadBalancerTlsCertificatesOutput, error)

GetLoadBalancerTlsCertificatesWithContext is the same as GetLoadBalancerTlsCertificates with the addition of the ability to pass a context and additional request options.

See GetLoadBalancerTlsCertificates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetLoadBalancerWithContext

func (c *Lightsail) GetLoadBalancerWithContext(ctx aws.Context, input *GetLoadBalancerInput, opts ...request.Option) (*GetLoadBalancerOutput, error)

GetLoadBalancerWithContext is the same as GetLoadBalancer with the addition of the ability to pass a context and additional request options.

See GetLoadBalancer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetLoadBalancers

func (c *Lightsail) GetLoadBalancers(input *GetLoadBalancersInput) (*GetLoadBalancersOutput, error)

GetLoadBalancers API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetLoadBalancers for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancers

GetLoadBalancersRequest

func (c *Lightsail) GetLoadBalancersRequest(input *GetLoadBalancersInput) (req *request.Request, output *GetLoadBalancersOutput)

GetLoadBalancersRequest generates a "aws/request.Request" representing the client's request for the GetLoadBalancers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLoadBalancers for more information on using the GetLoadBalancers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLoadBalancersRequest method. req, resp := client.GetLoadBalancersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancers

GetLoadBalancersWithContext

func (c *Lightsail) GetLoadBalancersWithContext(ctx aws.Context, input *GetLoadBalancersInput, opts ...request.Option) (*GetLoadBalancersOutput, error)

GetLoadBalancersWithContext is the same as GetLoadBalancers with the addition of the ability to pass a context and additional request options.

See GetLoadBalancers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetOperation

func (c *Lightsail) GetOperation(input *GetOperationInput) (*GetOperationOutput, error)

GetOperation API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetOperation for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperation

GetOperationRequest

func (c *Lightsail) GetOperationRequest(input *GetOperationInput) (req *request.Request, output *GetOperationOutput)

GetOperationRequest generates a "aws/request.Request" representing the client's request for the GetOperation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetOperation for more information on using the GetOperation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetOperationRequest method. req, resp := client.GetOperationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperation

GetOperationWithContext

func (c *Lightsail) GetOperationWithContext(ctx aws.Context, input *GetOperationInput, opts ...request.Option) (*GetOperationOutput, error)

GetOperationWithContext is the same as GetOperation with the addition of the ability to pass a context and additional request options.

See GetOperation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetOperations

func (c *Lightsail) GetOperations(input *GetOperationsInput) (*GetOperationsOutput, error)

GetOperations API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetOperations for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperations

GetOperationsForResource

func (c *Lightsail) GetOperationsForResource(input *GetOperationsForResourceInput) (*GetOperationsForResourceOutput, error)

GetOperationsForResource API operation for Amazon Lightsail.

Gets operations for a specific resource (e.g., an instance or a static IP).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetOperationsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsForResource

GetOperationsForResourceRequest

func (c *Lightsail) GetOperationsForResourceRequest(input *GetOperationsForResourceInput) (req *request.Request, output *GetOperationsForResourceOutput)

GetOperationsForResourceRequest generates a "aws/request.Request" representing the client's request for the GetOperationsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetOperationsForResource for more information on using the GetOperationsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetOperationsForResourceRequest method. req, resp := client.GetOperationsForResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsForResource

GetOperationsForResourceWithContext

func (c *Lightsail) GetOperationsForResourceWithContext(ctx aws.Context, input *GetOperationsForResourceInput, opts ...request.Option) (*GetOperationsForResourceOutput, error)

GetOperationsForResourceWithContext is the same as GetOperationsForResource with the addition of the ability to pass a context and additional request options.

See GetOperationsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetOperationsRequest

func (c *Lightsail) GetOperationsRequest(input *GetOperationsInput) (req *request.Request, output *GetOperationsOutput)

GetOperationsRequest generates a "aws/request.Request" representing the client's request for the GetOperations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetOperations for more information on using the GetOperations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetOperationsRequest method. req, resp := client.GetOperationsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperations

GetOperationsWithContext

func (c *Lightsail) GetOperationsWithContext(ctx aws.Context, input *GetOperationsInput, opts ...request.Option) (*GetOperationsOutput, error)

GetOperationsWithContext is the same as GetOperations with the addition of the ability to pass a context and additional request options.

See GetOperations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRegions

func (c *Lightsail) GetRegions(input *GetRegionsInput) (*GetRegionsOutput, error)

GetRegions API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRegions for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRegions

GetRegionsRequest

func (c *Lightsail) GetRegionsRequest(input *GetRegionsInput) (req *request.Request, output *GetRegionsOutput)

GetRegionsRequest generates a "aws/request.Request" representing the client's request for the GetRegions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRegions for more information on using the GetRegions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRegionsRequest method. req, resp := client.GetRegionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRegions

GetRegionsWithContext

func (c *Lightsail) GetRegionsWithContext(ctx aws.Context, input *GetRegionsInput, opts ...request.Option) (*GetRegionsOutput, error)

GetRegionsWithContext is the same as GetRegions with the addition of the ability to pass a context and additional request options.

See GetRegions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRelationalDatabase

func (c *Lightsail) GetRelationalDatabase(input *GetRelationalDatabaseInput) (*GetRelationalDatabaseOutput, error)

GetRelationalDatabase API operation for Amazon Lightsail.

Returns information about a specific database in Amazon Lightsail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabase for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabase

GetRelationalDatabaseBlueprints

func (c *Lightsail) GetRelationalDatabaseBlueprints(input *GetRelationalDatabaseBlueprintsInput) (*GetRelationalDatabaseBlueprintsOutput, error)

GetRelationalDatabaseBlueprints API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseBlueprints for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBlueprints

GetRelationalDatabaseBlueprintsRequest

func (c *Lightsail) GetRelationalDatabaseBlueprintsRequest(input *GetRelationalDatabaseBlueprintsInput) (req *request.Request, output *GetRelationalDatabaseBlueprintsOutput)

GetRelationalDatabaseBlueprintsRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseBlueprints operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseBlueprints for more information on using the GetRelationalDatabaseBlueprints API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseBlueprintsRequest method. req, resp := client.GetRelationalDatabaseBlueprintsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBlueprints

GetRelationalDatabaseBlueprintsWithContext

func (c *Lightsail) GetRelationalDatabaseBlueprintsWithContext(ctx aws.Context, input *GetRelationalDatabaseBlueprintsInput, opts ...request.Option) (*GetRelationalDatabaseBlueprintsOutput, error)

GetRelationalDatabaseBlueprintsWithContext is the same as GetRelationalDatabaseBlueprints with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseBlueprints for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRelationalDatabaseBundles

func (c *Lightsail) GetRelationalDatabaseBundles(input *GetRelationalDatabaseBundlesInput) (*GetRelationalDatabaseBundlesOutput, error)

GetRelationalDatabaseBundles API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseBundles for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBundles

GetRelationalDatabaseBundlesRequest

func (c *Lightsail) GetRelationalDatabaseBundlesRequest(input *GetRelationalDatabaseBundlesInput) (req *request.Request, output *GetRelationalDatabaseBundlesOutput)

GetRelationalDatabaseBundlesRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseBundles operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseBundles for more information on using the GetRelationalDatabaseBundles API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseBundlesRequest method. req, resp := client.GetRelationalDatabaseBundlesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBundles

GetRelationalDatabaseBundlesWithContext

func (c *Lightsail) GetRelationalDatabaseBundlesWithContext(ctx aws.Context, input *GetRelationalDatabaseBundlesInput, opts ...request.Option) (*GetRelationalDatabaseBundlesOutput, error)

GetRelationalDatabaseBundlesWithContext is the same as GetRelationalDatabaseBundles with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseBundles for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRelationalDatabaseEvents

func (c *Lightsail) GetRelationalDatabaseEvents(input *GetRelationalDatabaseEventsInput) (*GetRelationalDatabaseEventsOutput, error)

GetRelationalDatabaseEvents API operation for Amazon Lightsail.

Returns a list of events for a specific database in Amazon Lightsail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseEvents for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseEvents

GetRelationalDatabaseEventsRequest

func (c *Lightsail) GetRelationalDatabaseEventsRequest(input *GetRelationalDatabaseEventsInput) (req *request.Request, output *GetRelationalDatabaseEventsOutput)

GetRelationalDatabaseEventsRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseEvents for more information on using the GetRelationalDatabaseEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseEventsRequest method. req, resp := client.GetRelationalDatabaseEventsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseEvents

GetRelationalDatabaseEventsWithContext

func (c *Lightsail) GetRelationalDatabaseEventsWithContext(ctx aws.Context, input *GetRelationalDatabaseEventsInput, opts ...request.Option) (*GetRelationalDatabaseEventsOutput, error)

GetRelationalDatabaseEventsWithContext is the same as GetRelationalDatabaseEvents with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRelationalDatabaseLogEvents

func (c *Lightsail) GetRelationalDatabaseLogEvents(input *GetRelationalDatabaseLogEventsInput) (*GetRelationalDatabaseLogEventsOutput, error)

GetRelationalDatabaseLogEvents API operation for Amazon Lightsail.

Returns a list of log events for a database in Amazon Lightsail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseLogEvents for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogEvents

GetRelationalDatabaseLogEventsRequest

func (c *Lightsail) GetRelationalDatabaseLogEventsRequest(input *GetRelationalDatabaseLogEventsInput) (req *request.Request, output *GetRelationalDatabaseLogEventsOutput)

GetRelationalDatabaseLogEventsRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseLogEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseLogEvents for more information on using the GetRelationalDatabaseLogEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseLogEventsRequest method. req, resp := client.GetRelationalDatabaseLogEventsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogEvents

GetRelationalDatabaseLogEventsWithContext

func (c *Lightsail) GetRelationalDatabaseLogEventsWithContext(ctx aws.Context, input *GetRelationalDatabaseLogEventsInput, opts ...request.Option) (*GetRelationalDatabaseLogEventsOutput, error)

GetRelationalDatabaseLogEventsWithContext is the same as GetRelationalDatabaseLogEvents with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseLogEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRelationalDatabaseLogStreams

func (c *Lightsail) GetRelationalDatabaseLogStreams(input *GetRelationalDatabaseLogStreamsInput) (*GetRelationalDatabaseLogStreamsOutput, error)

GetRelationalDatabaseLogStreams API operation for Amazon Lightsail.

Returns a list of available log streams for a specific database in Amazon Lightsail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseLogStreams for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogStreams

GetRelationalDatabaseLogStreamsRequest

func (c *Lightsail) GetRelationalDatabaseLogStreamsRequest(input *GetRelationalDatabaseLogStreamsInput) (req *request.Request, output *GetRelationalDatabaseLogStreamsOutput)

GetRelationalDatabaseLogStreamsRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseLogStreams operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseLogStreams for more information on using the GetRelationalDatabaseLogStreams API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseLogStreamsRequest method. req, resp := client.GetRelationalDatabaseLogStreamsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogStreams

GetRelationalDatabaseLogStreamsWithContext

func (c *Lightsail) GetRelationalDatabaseLogStreamsWithContext(ctx aws.Context, input *GetRelationalDatabaseLogStreamsInput, opts ...request.Option) (*GetRelationalDatabaseLogStreamsOutput, error)

GetRelationalDatabaseLogStreamsWithContext is the same as GetRelationalDatabaseLogStreams with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseLogStreams for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRelationalDatabaseMasterUserPassword

func (c *Lightsail) GetRelationalDatabaseMasterUserPassword(input *GetRelationalDatabaseMasterUserPasswordInput) (*GetRelationalDatabaseMasterUserPasswordOutput, error)

GetRelationalDatabaseMasterUserPassword API operation for Amazon Lightsail.

Returns the current, previous, or pending versions of the master user password for a Lightsail database.

The asdf operation GetRelationalDatabaseMasterUserPassword supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseMasterUserPassword for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPassword

GetRelationalDatabaseMasterUserPasswordRequest

func (c *Lightsail) GetRelationalDatabaseMasterUserPasswordRequest(input *GetRelationalDatabaseMasterUserPasswordInput) (req *request.Request, output *GetRelationalDatabaseMasterUserPasswordOutput)

GetRelationalDatabaseMasterUserPasswordRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseMasterUserPassword operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseMasterUserPassword for more information on using the GetRelationalDatabaseMasterUserPassword API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseMasterUserPasswordRequest method. req, resp := client.GetRelationalDatabaseMasterUserPasswordRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPassword

GetRelationalDatabaseMasterUserPasswordWithContext

func (c *Lightsail) GetRelationalDatabaseMasterUserPasswordWithContext(ctx aws.Context, input *GetRelationalDatabaseMasterUserPasswordInput, opts ...request.Option) (*GetRelationalDatabaseMasterUserPasswordOutput, error)

GetRelationalDatabaseMasterUserPasswordWithContext is the same as GetRelationalDatabaseMasterUserPassword with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseMasterUserPassword for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRelationalDatabaseMetricData

func (c *Lightsail) GetRelationalDatabaseMetricData(input *GetRelationalDatabaseMetricDataInput) (*GetRelationalDatabaseMetricDataOutput, error)

GetRelationalDatabaseMetricData API operation for Amazon Lightsail.

Returns the data points of the specified metric for a database in Amazon Lightsail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseMetricData for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMetricData

GetRelationalDatabaseMetricDataRequest

func (c *Lightsail) GetRelationalDatabaseMetricDataRequest(input *GetRelationalDatabaseMetricDataInput) (req *request.Request, output *GetRelationalDatabaseMetricDataOutput)

GetRelationalDatabaseMetricDataRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseMetricData operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseMetricData for more information on using the GetRelationalDatabaseMetricData API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseMetricDataRequest method. req, resp := client.GetRelationalDatabaseMetricDataRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMetricData

GetRelationalDatabaseMetricDataWithContext

func (c *Lightsail) GetRelationalDatabaseMetricDataWithContext(ctx aws.Context, input *GetRelationalDatabaseMetricDataInput, opts ...request.Option) (*GetRelationalDatabaseMetricDataOutput, error)

GetRelationalDatabaseMetricDataWithContext is the same as GetRelationalDatabaseMetricData with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseMetricData for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRelationalDatabaseParameters

func (c *Lightsail) GetRelationalDatabaseParameters(input *GetRelationalDatabaseParametersInput) (*GetRelationalDatabaseParametersOutput, error)

GetRelationalDatabaseParameters API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseParameters for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseParameters

GetRelationalDatabaseParametersRequest

func (c *Lightsail) GetRelationalDatabaseParametersRequest(input *GetRelationalDatabaseParametersInput) (req *request.Request, output *GetRelationalDatabaseParametersOutput)

GetRelationalDatabaseParametersRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseParameters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseParameters for more information on using the GetRelationalDatabaseParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseParametersRequest method. req, resp := client.GetRelationalDatabaseParametersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseParameters

GetRelationalDatabaseParametersWithContext

func (c *Lightsail) GetRelationalDatabaseParametersWithContext(ctx aws.Context, input *GetRelationalDatabaseParametersInput, opts ...request.Option) (*GetRelationalDatabaseParametersOutput, error)

GetRelationalDatabaseParametersWithContext is the same as GetRelationalDatabaseParameters with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseParameters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRelationalDatabaseRequest

func (c *Lightsail) GetRelationalDatabaseRequest(input *GetRelationalDatabaseInput) (req *request.Request, output *GetRelationalDatabaseOutput)

GetRelationalDatabaseRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabase for more information on using the GetRelationalDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseRequest method. req, resp := client.GetRelationalDatabaseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabase

GetRelationalDatabaseSnapshot

func (c *Lightsail) GetRelationalDatabaseSnapshot(input *GetRelationalDatabaseSnapshotInput) (*GetRelationalDatabaseSnapshotOutput, error)

GetRelationalDatabaseSnapshot API operation for Amazon Lightsail.

Returns information about a specific database snapshot in Amazon Lightsail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshot

GetRelationalDatabaseSnapshotRequest

func (c *Lightsail) GetRelationalDatabaseSnapshotRequest(input *GetRelationalDatabaseSnapshotInput) (req *request.Request, output *GetRelationalDatabaseSnapshotOutput)

GetRelationalDatabaseSnapshotRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseSnapshot for more information on using the GetRelationalDatabaseSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseSnapshotRequest method. req, resp := client.GetRelationalDatabaseSnapshotRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshot

GetRelationalDatabaseSnapshotWithContext

func (c *Lightsail) GetRelationalDatabaseSnapshotWithContext(ctx aws.Context, input *GetRelationalDatabaseSnapshotInput, opts ...request.Option) (*GetRelationalDatabaseSnapshotOutput, error)

GetRelationalDatabaseSnapshotWithContext is the same as GetRelationalDatabaseSnapshot with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRelationalDatabaseSnapshots

func (c *Lightsail) GetRelationalDatabaseSnapshots(input *GetRelationalDatabaseSnapshotsInput) (*GetRelationalDatabaseSnapshotsOutput, error)

GetRelationalDatabaseSnapshots API operation for Amazon Lightsail.

Returns information about all of your database snapshots in Amazon Lightsail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseSnapshots for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshots

GetRelationalDatabaseSnapshotsRequest

func (c *Lightsail) GetRelationalDatabaseSnapshotsRequest(input *GetRelationalDatabaseSnapshotsInput) (req *request.Request, output *GetRelationalDatabaseSnapshotsOutput)

GetRelationalDatabaseSnapshotsRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseSnapshots operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseSnapshots for more information on using the GetRelationalDatabaseSnapshots API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseSnapshotsRequest method. req, resp := client.GetRelationalDatabaseSnapshotsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshots

GetRelationalDatabaseSnapshotsWithContext

func (c *Lightsail) GetRelationalDatabaseSnapshotsWithContext(ctx aws.Context, input *GetRelationalDatabaseSnapshotsInput, opts ...request.Option) (*GetRelationalDatabaseSnapshotsOutput, error)

GetRelationalDatabaseSnapshotsWithContext is the same as GetRelationalDatabaseSnapshots with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseSnapshots for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRelationalDatabaseWithContext

func (c *Lightsail) GetRelationalDatabaseWithContext(ctx aws.Context, input *GetRelationalDatabaseInput, opts ...request.Option) (*GetRelationalDatabaseOutput, error)

GetRelationalDatabaseWithContext is the same as GetRelationalDatabase with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetRelationalDatabases

func (c *Lightsail) GetRelationalDatabases(input *GetRelationalDatabasesInput) (*GetRelationalDatabasesOutput, error)

GetRelationalDatabases API operation for Amazon Lightsail.

Returns information about all of your databases in Amazon Lightsail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabases for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabases

GetRelationalDatabasesRequest

func (c *Lightsail) GetRelationalDatabasesRequest(input *GetRelationalDatabasesInput) (req *request.Request, output *GetRelationalDatabasesOutput)

GetRelationalDatabasesRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabases operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabases for more information on using the GetRelationalDatabases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabasesRequest method. req, resp := client.GetRelationalDatabasesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabases

GetRelationalDatabasesWithContext

func (c *Lightsail) GetRelationalDatabasesWithContext(ctx aws.Context, input *GetRelationalDatabasesInput, opts ...request.Option) (*GetRelationalDatabasesOutput, error)

GetRelationalDatabasesWithContext is the same as GetRelationalDatabases with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabases for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetStaticIp

func (c *Lightsail) GetStaticIp(input *GetStaticIpInput) (*GetStaticIpOutput, error)

GetStaticIp API operation for Amazon Lightsail.

Returns information about a specific static IP.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetStaticIp for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIp

GetStaticIpRequest

func (c *Lightsail) GetStaticIpRequest(input *GetStaticIpInput) (req *request.Request, output *GetStaticIpOutput)

GetStaticIpRequest generates a "aws/request.Request" representing the client's request for the GetStaticIp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetStaticIp for more information on using the GetStaticIp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetStaticIpRequest method. req, resp := client.GetStaticIpRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIp

GetStaticIpWithContext

func (c *Lightsail) GetStaticIpWithContext(ctx aws.Context, input *GetStaticIpInput, opts ...request.Option) (*GetStaticIpOutput, error)

GetStaticIpWithContext is the same as GetStaticIp with the addition of the ability to pass a context and additional request options.

See GetStaticIp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetStaticIps

func (c *Lightsail) GetStaticIps(input *GetStaticIpsInput) (*GetStaticIpsOutput, error)

GetStaticIps API operation for Amazon Lightsail.

Returns information about all static IPs in the user's account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetStaticIps for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIps

GetStaticIpsRequest

func (c *Lightsail) GetStaticIpsRequest(input *GetStaticIpsInput) (req *request.Request, output *GetStaticIpsOutput)

GetStaticIpsRequest generates a "aws/request.Request" representing the client's request for the GetStaticIps operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetStaticIps for more information on using the GetStaticIps API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetStaticIpsRequest method. req, resp := client.GetStaticIpsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIps

GetStaticIpsWithContext

func (c *Lightsail) GetStaticIpsWithContext(ctx aws.Context, input *GetStaticIpsInput, opts ...request.Option) (*GetStaticIpsOutput, error)

GetStaticIpsWithContext is the same as GetStaticIps with the addition of the ability to pass a context and additional request options.

See GetStaticIps for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ImportKeyPair

func (c *Lightsail) ImportKeyPair(input *ImportKeyPairInput) (*ImportKeyPairOutput, error)

ImportKeyPair API operation for Amazon Lightsail.

Imports a public SSH key from a specific key pair.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation ImportKeyPair for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ImportKeyPair

ImportKeyPairRequest

func (c *Lightsail) ImportKeyPairRequest(input *ImportKeyPairInput) (req *request.Request, output *ImportKeyPairOutput)

ImportKeyPairRequest generates a "aws/request.Request" representing the client's request for the ImportKeyPair operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ImportKeyPair for more information on using the ImportKeyPair API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ImportKeyPairRequest method. req, resp := client.ImportKeyPairRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ImportKeyPair

ImportKeyPairWithContext

func (c *Lightsail) ImportKeyPairWithContext(ctx aws.Context, input *ImportKeyPairInput, opts ...request.Option) (*ImportKeyPairOutput, error)

ImportKeyPairWithContext is the same as ImportKeyPair with the addition of the ability to pass a context and additional request options.

See ImportKeyPair for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

IsVpcPeered

func (c *Lightsail) IsVpcPeered(input *IsVpcPeeredInput) (*IsVpcPeeredOutput, error)

IsVpcPeered API operation for Amazon Lightsail.

Returns a Boolean value indicating whether your Lightsail VPC is peered.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation IsVpcPeered for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/IsVpcPeered

IsVpcPeeredRequest

func (c *Lightsail) IsVpcPeeredRequest(input *IsVpcPeeredInput) (req *request.Request, output *IsVpcPeeredOutput)

IsVpcPeeredRequest generates a "aws/request.Request" representing the client's request for the IsVpcPeered operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See IsVpcPeered for more information on using the IsVpcPeered API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the IsVpcPeeredRequest method. req, resp := client.IsVpcPeeredRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/IsVpcPeered

IsVpcPeeredWithContext

func (c *Lightsail) IsVpcPeeredWithContext(ctx aws.Context, input *IsVpcPeeredInput, opts ...request.Option) (*IsVpcPeeredOutput, error)

IsVpcPeeredWithContext is the same as IsVpcPeered with the addition of the ability to pass a context and additional request options.

See IsVpcPeered for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

OpenInstancePublicPorts

func (c *Lightsail) OpenInstancePublicPorts(input *OpenInstancePublicPortsInput) (*OpenInstancePublicPortsOutput, error)

OpenInstancePublicPorts API operation for Amazon Lightsail.

Adds public ports to an Amazon Lightsail instance.

The open instance public ports operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation OpenInstancePublicPorts for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/OpenInstancePublicPorts

OpenInstancePublicPortsRequest

func (c *Lightsail) OpenInstancePublicPortsRequest(input *OpenInstancePublicPortsInput) (req *request.Request, output *OpenInstancePublicPortsOutput)

OpenInstancePublicPortsRequest generates a "aws/request.Request" representing the client's request for the OpenInstancePublicPorts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See OpenInstancePublicPorts for more information on using the OpenInstancePublicPorts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the OpenInstancePublicPortsRequest method. req, resp := client.OpenInstancePublicPortsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/OpenInstancePublicPorts

OpenInstancePublicPortsWithContext

func (c *Lightsail) OpenInstancePublicPortsWithContext(ctx aws.Context, input *OpenInstancePublicPortsInput, opts ...request.Option) (*OpenInstancePublicPortsOutput, error)

OpenInstancePublicPortsWithContext is the same as OpenInstancePublicPorts with the addition of the ability to pass a context and additional request options.

See OpenInstancePublicPorts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

PeerVpc

func (c *Lightsail) PeerVpc(input *PeerVpcInput) (*PeerVpcOutput, error)

PeerVpc API operation for Amazon Lightsail.

Tries to peer the Lightsail VPC with the user's default VPC.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation PeerVpc for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PeerVpc

PeerVpcRequest

func (c *Lightsail) PeerVpcRequest(input *PeerVpcInput) (req *request.Request, output *PeerVpcOutput)

PeerVpcRequest generates a "aws/request.Request" representing the client's request for the PeerVpc operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PeerVpc for more information on using the PeerVpc API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PeerVpcRequest method. req, resp := client.PeerVpcRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PeerVpc

PeerVpcWithContext

func (c *Lightsail) PeerVpcWithContext(ctx aws.Context, input *PeerVpcInput, opts ...request.Option) (*PeerVpcOutput, error)

PeerVpcWithContext is the same as PeerVpc with the addition of the ability to pass a context and additional request options.

See PeerVpc for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

PutInstancePublicPorts

func (c *Lightsail) PutInstancePublicPorts(input *PutInstancePublicPortsInput) (*PutInstancePublicPortsOutput, error)

PutInstancePublicPorts API operation for Amazon Lightsail.

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

The put instance public ports operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation PutInstancePublicPorts for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutInstancePublicPorts

PutInstancePublicPortsRequest

func (c *Lightsail) PutInstancePublicPortsRequest(input *PutInstancePublicPortsInput) (req *request.Request, output *PutInstancePublicPortsOutput)

PutInstancePublicPortsRequest generates a "aws/request.Request" representing the client's request for the PutInstancePublicPorts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutInstancePublicPorts for more information on using the PutInstancePublicPorts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutInstancePublicPortsRequest method. req, resp := client.PutInstancePublicPortsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutInstancePublicPorts

PutInstancePublicPortsWithContext

func (c *Lightsail) PutInstancePublicPortsWithContext(ctx aws.Context, input *PutInstancePublicPortsInput, opts ...request.Option) (*PutInstancePublicPortsOutput, error)

PutInstancePublicPortsWithContext is the same as PutInstancePublicPorts with the addition of the ability to pass a context and additional request options.

See PutInstancePublicPorts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

RebootInstance

func (c *Lightsail) RebootInstance(input *RebootInstanceInput) (*RebootInstanceOutput, error)

RebootInstance API operation for Amazon Lightsail.

Restarts a specific instance.

The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation RebootInstance for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootInstance

RebootInstanceRequest

func (c *Lightsail) RebootInstanceRequest(input *RebootInstanceInput) (req *request.Request, output *RebootInstanceOutput)

RebootInstanceRequest generates a "aws/request.Request" representing the client's request for the RebootInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RebootInstance for more information on using the RebootInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RebootInstanceRequest method. req, resp := client.RebootInstanceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootInstance

RebootInstanceWithContext

func (c *Lightsail) RebootInstanceWithContext(ctx aws.Context, input *RebootInstanceInput, opts ...request.Option) (*RebootInstanceOutput, error)

RebootInstanceWithContext is the same as RebootInstance with the addition of the ability to pass a context and additional request options.

See RebootInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

RebootRelationalDatabase

func (c *Lightsail) RebootRelationalDatabase(input *RebootRelationalDatabaseInput) (*RebootRelationalDatabaseOutput, error)

RebootRelationalDatabase API operation for Amazon Lightsail.

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 Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation RebootRelationalDatabase for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootRelationalDatabase

RebootRelationalDatabaseRequest

func (c *Lightsail) RebootRelationalDatabaseRequest(input *RebootRelationalDatabaseInput) (req *request.Request, output *RebootRelationalDatabaseOutput)

RebootRelationalDatabaseRequest generates a "aws/request.Request" representing the client's request for the RebootRelationalDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RebootRelationalDatabase for more information on using the RebootRelationalDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RebootRelationalDatabaseRequest method. req, resp := client.RebootRelationalDatabaseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootRelationalDatabase

RebootRelationalDatabaseWithContext

func (c *Lightsail) RebootRelationalDatabaseWithContext(ctx aws.Context, input *RebootRelationalDatabaseInput, opts ...request.Option) (*RebootRelationalDatabaseOutput, error)

RebootRelationalDatabaseWithContext is the same as RebootRelationalDatabase with the addition of the ability to pass a context and additional request options.

See RebootRelationalDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ReleaseStaticIp

func (c *Lightsail) ReleaseStaticIp(input *ReleaseStaticIpInput) (*ReleaseStaticIpOutput, error)

ReleaseStaticIp API operation for Amazon Lightsail.

Deletes a specific static IP from your account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation ReleaseStaticIp for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" 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 AWS Region configuration to us-east-1 to create, view, or edit these resources.
  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

</