Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Lightsail.Lens

Contents

Operations
Types

Description

Synopsis

Operations

CloseInstancePublicPorts

closeInstancePublicPorts_portInfo :: Lens' CloseInstancePublicPorts PortInfo Source #

An object to describe the ports to close for the specified instance.

closeInstancePublicPorts_instanceName :: Lens' CloseInstancePublicPorts Text Source #

The name of the instance for which to close ports.

closeInstancePublicPortsResponse_operation :: Lens' CloseInstancePublicPortsResponse (Maybe Operation) Source #

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

closeInstancePublicPortsResponse_httpStatus :: Lens' CloseInstancePublicPortsResponse Int Source #

The response's http status code.

GetRelationalDatabaseMetricData

getRelationalDatabaseMetricData_relationalDatabaseName :: Lens' GetRelationalDatabaseMetricData Text Source #

The name of your database from which to get metric data.

getRelationalDatabaseMetricData_metricName :: Lens' GetRelationalDatabaseMetricData RelationalDatabaseMetricName Source #

The metric for which you want to return information.

Valid relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity.

CPUUtilization - The percentage of CPU utilization currently in use on the database.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Percent.
DatabaseConnections - The number of database connections in use.
Statistics: The most useful statistics are Maximum and Sum.
Unit: The published unit is Count.
DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
FreeStorageSpace - The amount of available storage space.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Bytes.
NetworkReceiveThroughput - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.
Statistics: The most useful statistic is Average.
Unit: The published unit is Bytes/Second.
NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.
Statistics: The most useful statistic is Average.
Unit: The published unit is Bytes/Second.

getRelationalDatabaseMetricData_period :: Lens' GetRelationalDatabaseMetricData Natural Source #

The granularity, in seconds, of the returned data points.

All relational database metric data is available in 1-minute (60 seconds) granularity.

getRelationalDatabaseMetricData_startTime :: Lens' GetRelationalDatabaseMetricData UTCTime Source #

The start of the time interval from which to get metric data.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

getRelationalDatabaseMetricData_endTime :: Lens' GetRelationalDatabaseMetricData UTCTime Source #

The end of the time interval from which to get metric data.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

getRelationalDatabaseMetricData_unit :: Lens' GetRelationalDatabaseMetricData MetricUnit Source #

The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

getRelationalDatabaseMetricData_statistics :: Lens' GetRelationalDatabaseMetricData [MetricStatistic] Source #

The statistic for the metric.

The following statistics are available:

Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
SampleCount - The count, or number, of data points used for the statistical calculation.

getRelationalDatabaseMetricDataResponse_metricName :: Lens' GetRelationalDatabaseMetricDataResponse (Maybe RelationalDatabaseMetricName) Source #

The name of the metric returned.

getRelationalDatabaseMetricDataResponse_metricData :: Lens' GetRelationalDatabaseMetricDataResponse (Maybe [MetricDatapoint]) Source #

An array of objects that describe the metric data returned.

getRelationalDatabaseMetricDataResponse_httpStatus :: Lens' GetRelationalDatabaseMetricDataResponse Int Source #

The response's http status code.

DeleteBucketAccessKey

deleteBucketAccessKey_bucketName :: Lens' DeleteBucketAccessKey Text Source #

The name of the bucket that the access key belongs to.

deleteBucketAccessKey_accessKeyId :: Lens' DeleteBucketAccessKey Text Source #

The ID of the access key to delete.

Use the GetBucketAccessKeys action to get a list of access key IDs that you can specify.

deleteBucketAccessKeyResponse_operations :: Lens' DeleteBucketAccessKeyResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

deleteBucketAccessKeyResponse_httpStatus :: Lens' DeleteBucketAccessKeyResponse Int Source #

The response's http status code.

AllocateStaticIp

allocateStaticIp_staticIpName :: Lens' AllocateStaticIp Text Source #

The name of the static IP address.

allocateStaticIpResponse_operations :: Lens' AllocateStaticIpResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

allocateStaticIpResponse_httpStatus :: Lens' AllocateStaticIpResponse Int Source #

The response's http status code.

DeleteKeyPair

deleteKeyPair_keyPairName :: Lens' DeleteKeyPair Text Source #

The name of the key pair to delete.

deleteKeyPairResponse_operation :: Lens' DeleteKeyPairResponse (Maybe Operation) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

deleteKeyPairResponse_httpStatus :: Lens' DeleteKeyPairResponse Int Source #

The response's http status code.

DeleteInstanceSnapshot

deleteInstanceSnapshot_instanceSnapshotName :: Lens' DeleteInstanceSnapshot Text Source #

The name of the snapshot to delete.

deleteInstanceSnapshotResponse_operations :: Lens' DeleteInstanceSnapshotResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

deleteInstanceSnapshotResponse_httpStatus :: Lens' DeleteInstanceSnapshotResponse Int Source #

The response's http status code.

GetInstances

getInstances_pageToken :: Lens' GetInstances (Maybe Text) Source #

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetInstances request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

getInstancesResponse_nextPageToken :: Lens' GetInstancesResponse (Maybe Text) Source #

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetInstances request and specify the next page token using the pageToken parameter.

getInstancesResponse_instances :: Lens' GetInstancesResponse (Maybe [Instance]) Source #

An array of key-value pairs containing information about your instances.

getInstancesResponse_httpStatus :: Lens' GetInstancesResponse Int Source #

The response's http status code.

GetLoadBalancer

getLoadBalancer_loadBalancerName :: Lens' GetLoadBalancer Text Source #

The name of the load balancer.

getLoadBalancerResponse_loadBalancer :: Lens' GetLoadBalancerResponse (Maybe LoadBalancer) Source #

An object containing information about your load balancer.

getLoadBalancerResponse_httpStatus :: Lens' GetLoadBalancerResponse Int Source #

The response's http status code.

DisableAddOn

disableAddOn_addOnType :: Lens' DisableAddOn AddOnType Source #

The add-on type to disable.

disableAddOn_resourceName :: Lens' DisableAddOn Text Source #

The name of the source resource for which to disable the add-on.

disableAddOnResponse_operations :: Lens' DisableAddOnResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

disableAddOnResponse_httpStatus :: Lens' DisableAddOnResponse Int Source #

The response's http status code.

GetDistributions

getDistributions_distributionName :: Lens' GetDistributions (Maybe Text) Source #

The name of the distribution for which to return information.

When omitted, the response includes all of your distributions in the AWS Region where the request is made.

getDistributions_pageToken :: Lens' GetDistributions (Maybe Text) Source #

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDistributions request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

getDistributionsResponse_nextPageToken :: Lens' GetDistributionsResponse (Maybe Text) Source #

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetDistributions request and specify the next page token using the pageToken parameter.

getDistributionsResponse_distributions :: Lens' GetDistributionsResponse (Maybe [LightsailDistribution]) Source #

An array of objects that describe your distributions.

getDistributionsResponse_httpStatus :: Lens' GetDistributionsResponse Int Source #

The response's http status code.

CreateContainerServiceDeployment

createContainerServiceDeployment_publicEndpoint :: Lens' CreateContainerServiceDeployment (Maybe EndpointRequest) Source #

An object that describes the settings of the public endpoint for the container service.

createContainerServiceDeployment_containers :: Lens' CreateContainerServiceDeployment (Maybe (HashMap Text Container)) Source #

An object that describes the settings of the containers that will be launched on the container service.

createContainerServiceDeployment_serviceName :: Lens' CreateContainerServiceDeployment Text Source #

The name of the container service for which to create the deployment.

createContainerServiceDeploymentResponse_containerService :: Lens' CreateContainerServiceDeploymentResponse (Maybe ContainerService) Source #

An object that describes a container service.

createContainerServiceDeploymentResponse_httpStatus :: Lens' CreateContainerServiceDeploymentResponse Int Source #

The response's http status code.

GetInstance

getInstance_instanceName :: Lens' GetInstance Text Source #

The name of the instance.

getInstanceResponse_instance :: Lens' GetInstanceResponse (Maybe Instance) Source #

An array of key-value pairs containing information about the specified instance.

getInstanceResponse_httpStatus :: Lens' GetInstanceResponse Int Source #

The response's http status code.

DeleteBucket

deleteBucket_forceDelete :: Lens' DeleteBucket (Maybe Bool) Source #

A Boolean value that indicates whether to force delete the bucket.

You must force delete the bucket if it has one of the following conditions:

The bucket is the origin of a distribution.
The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.
The bucket has objects.
The bucket has access keys.

Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.

deleteBucket_bucketName :: Lens' DeleteBucket Text Source #

The name of the bucket to delete.

Use the GetBuckets action to get a list of bucket names that you can specify.

deleteBucketResponse_operations :: Lens' DeleteBucketResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

deleteBucketResponse_httpStatus :: Lens' DeleteBucketResponse Int Source #

The response's http status code.

UpdateBucket

updateBucket_readonlyAccessAccounts :: Lens' UpdateBucket (Maybe [Text]) Source #

An array of strings to specify the AWS account IDs that can access the bucket.

You can give a maximum of 10 AWS accounts access to a bucket.

updateBucket_accessRules :: Lens' UpdateBucket (Maybe AccessRules) Source #

An object that sets the public accessibility of objects in the specified bucket.

updateBucket_versioning :: Lens' UpdateBucket (Maybe Text) Source #

Specifies whether to enable or suspend versioning of objects in the bucket.

The following options can be specified:

Enabled - Enables versioning of objects in the specified bucket.
Suspended - Suspends versioning of objects in the specified bucket. Existing object versions are retained.

updateBucket_bucketName :: Lens' UpdateBucket Text Source #

The name of the bucket to update.

updateBucketResponse_bucket :: Lens' UpdateBucketResponse (Maybe Bucket) Source #

An object that describes the bucket that is updated.

updateBucketResponse_operations :: Lens' UpdateBucketResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

updateBucketResponse_httpStatus :: Lens' UpdateBucketResponse Int Source #

The response's http status code.

GetRelationalDatabaseEvents

getRelationalDatabaseEvents_durationInMinutes :: Lens' GetRelationalDatabaseEvents (Maybe Int) Source #

The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120.

Default: 60

The minimum is 1 and the maximum is 14 days (20160 minutes).

getRelationalDatabaseEvents_pageToken :: Lens' GetRelationalDatabaseEvents (Maybe Text) Source #

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseEvents request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

getRelationalDatabaseEvents_relationalDatabaseName :: Lens' GetRelationalDatabaseEvents Text Source #

The name of the database from which to get events.

getRelationalDatabaseEventsResponse_nextPageToken :: Lens' GetRelationalDatabaseEventsResponse (Maybe Text) Source #

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabaseEvents request and specify the next page token using the pageToken parameter.

getRelationalDatabaseEventsResponse_relationalDatabaseEvents :: Lens' GetRelationalDatabaseEventsResponse (Maybe [RelationalDatabaseEvent]) Source #

An object describing the result of your get relational database events request.

getRelationalDatabaseEventsResponse_httpStatus :: Lens' GetRelationalDatabaseEventsResponse Int Source #

The response's http status code.

AttachCertificateToDistribution

attachCertificateToDistribution_distributionName :: Lens' AttachCertificateToDistribution Text Source #

The name of the distribution that the certificate will be attached to.

Use the GetDistributions action to get a list of distribution names that you can specify.

attachCertificateToDistribution_certificateName :: Lens' AttachCertificateToDistribution Text Source #

The name of the certificate to attach to a distribution.

Only certificates with a status of ISSUED can be attached to a distribution.

Use the GetCertificates action to get a list of certificate names that you can specify.

This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might be WordPress-Blog-Certificate and the domain name of the certificate might be example.com.

attachCertificateToDistributionResponse_operation :: Lens' AttachCertificateToDistributionResponse (Maybe Operation) Source #

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

attachCertificateToDistributionResponse_httpStatus :: Lens' AttachCertificateToDistributionResponse Int Source #

The response's http status code.

GetContainerServices

getContainerServices_serviceName :: Lens' GetContainerServices (Maybe Text) Source #

The name of the container service for which to return information.

When omitted, the response includes all of your container services in the AWS Region where the request is made.

getContainerServicesResponse_containerServices :: Lens' GetContainerServicesResponse (Maybe [ContainerService]) Source #

An array of objects that describe one or more container services.

getContainerServicesResponse_httpStatus :: Lens' GetContainerServicesResponse Int Source #

The response's http status code.

UpdateDistributionBundle

updateDistributionBundle_bundleId :: Lens' UpdateDistributionBundle (Maybe Text) Source #

The bundle ID of the new bundle to apply to your distribution.

Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.

updateDistributionBundle_distributionName :: Lens' UpdateDistributionBundle (Maybe Text) Source #

The name of the distribution for which to update the bundle.

Use the GetDistributions action to get a list of distribution names that you can specify.

updateDistributionBundleResponse_operation :: Lens' UpdateDistributionBundleResponse (Maybe Operation) Source #

Undocumented member.

updateDistributionBundleResponse_httpStatus :: Lens' UpdateDistributionBundleResponse Int Source #

The response's http status code.

GetRelationalDatabaseSnapshots

getRelationalDatabaseSnapshots_pageToken :: Lens' GetRelationalDatabaseSnapshots (Maybe Text) Source #

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

getRelationalDatabaseSnapshotsResponse_nextPageToken :: Lens' GetRelationalDatabaseSnapshotsResponse (Maybe Text) Source #

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabaseSnapshots request and specify the next page token using the pageToken parameter.

getRelationalDatabaseSnapshotsResponse_relationalDatabaseSnapshots :: Lens' GetRelationalDatabaseSnapshotsResponse (Maybe [RelationalDatabaseSnapshot]) Source #

An object describing the result of your get relational database snapshots request.

getRelationalDatabaseSnapshotsResponse_httpStatus :: Lens' GetRelationalDatabaseSnapshotsResponse Int Source #

The response's http status code.

GetBucketBundles

getBucketBundles_includeInactive :: Lens' GetBucketBundles (Maybe Bool) Source #

A Boolean value that indicates whether to include inactive (unavailable) bundles in the response.

getBucketBundlesResponse_bundles :: Lens' GetBucketBundlesResponse (Maybe [BucketBundle]) Source #

An object that describes bucket bundles.

getBucketBundlesResponse_httpStatus :: Lens' GetBucketBundlesResponse Int Source #

The response's http status code.

CreateBucket

createBucket_enableObjectVersioning :: Lens' CreateBucket (Maybe Bool) Source #

A Boolean value that indicates whether to enable versioning of objects in the bucket.

For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

createBucket_tags :: Lens' CreateBucket (Maybe [Tag]) Source #

The tag keys and optional values to add to the bucket during creation.

Use the TagResource action to tag the bucket after it's created.

createBucket_bucketName :: Lens' CreateBucket Text Source #

The name for the bucket.

For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer Guide.

createBucket_bundleId :: Lens' CreateBucket Text Source #

The ID of the bundle to use for the bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Use the GetBucketBundles action to get a list of bundle IDs that you can specify.

Use the UpdateBucketBundle action to change the bundle after the bucket is created.

createBucketResponse_bucket :: Lens' CreateBucketResponse (Maybe Bucket) Source #

An object that describes the bucket that is created.

createBucketResponse_operations :: Lens' CreateBucketResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

createBucketResponse_httpStatus :: Lens' CreateBucketResponse Int Source #

The response's http status code.

AttachStaticIp

attachStaticIp_staticIpName :: Lens' AttachStaticIp Text Source #

The name of the static IP.

attachStaticIp_instanceName :: Lens' AttachStaticIp Text Source #

The instance name to which you want to attach the static IP address.

attachStaticIpResponse_operations :: Lens' AttachStaticIpResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

attachStaticIpResponse_httpStatus :: Lens' AttachStaticIpResponse Int Source #

The response's http status code.

GetRelationalDatabaseParameters

getRelationalDatabaseParameters_pageToken :: Lens' GetRelationalDatabaseParameters (Maybe Text) Source #

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseParameters request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

getRelationalDatabaseParameters_relationalDatabaseName :: Lens' GetRelationalDatabaseParameters Text Source #

The name of your database for which to get parameters.

getRelationalDatabaseParametersResponse_nextPageToken :: Lens' GetRelationalDatabaseParametersResponse (Maybe Text) Source #

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabaseParameters request and specify the next page token using the pageToken parameter.

getRelationalDatabaseParametersResponse_parameters :: Lens' GetRelationalDatabaseParametersResponse (Maybe [RelationalDatabaseParameter]) Source #

An object describing the result of your get relational database parameters request.

getRelationalDatabaseParametersResponse_httpStatus :: Lens' GetRelationalDatabaseParametersResponse Int Source #

The response's http status code.

DetachDisk

detachDisk_diskName :: Lens' DetachDisk Text Source #

The unique name of the disk you want to detach from your instance (e.g., my-disk).

detachDiskResponse_operations :: Lens' DetachDiskResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

detachDiskResponse_httpStatus :: Lens' DetachDiskResponse Int Source #

The response's http status code.

GetContactMethods

getContactMethods_protocols :: Lens' GetContactMethods (Maybe [ContactProtocol]) Source #

The protocols used to send notifications, such as Email, or SMS (text messaging).

Specify a protocol in your request to return information about a specific contact method protocol.

getContactMethodsResponse_contactMethods :: Lens' GetContactMethodsResponse (Maybe [ContactMethod]) Source #

An array of objects that describe the contact methods.

getContactMethodsResponse_httpStatus :: Lens' GetContactMethodsResponse Int Source #

The response's http status code.

DownloadDefaultKeyPair

downloadDefaultKeyPairResponse_publicKeyBase64 :: Lens' DownloadDefaultKeyPairResponse (Maybe Text) Source #

A base64-encoded public key of the ssh-rsa type.

downloadDefaultKeyPairResponse_privateKeyBase64 :: Lens' DownloadDefaultKeyPairResponse (Maybe Text) Source #

A base64-encoded RSA private key.

downloadDefaultKeyPairResponse_httpStatus :: Lens' DownloadDefaultKeyPairResponse Int Source #

The response's http status code.

DeleteLoadBalancerTlsCertificate

deleteLoadBalancerTlsCertificate_force :: Lens' DeleteLoadBalancerTlsCertificate (Maybe Bool) Source #

When true, forces the deletion of an SSL/TLS certificate.

There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The force parameter is required when the primary SSL/TLS certificate is in use by an instance attached to the load balancer.

deleteLoadBalancerTlsCertificate_loadBalancerName :: Lens' DeleteLoadBalancerTlsCertificate Text Source #

The load balancer name.

deleteLoadBalancerTlsCertificate_certificateName :: Lens' DeleteLoadBalancerTlsCertificate Text Source #

The SSL/TLS certificate name.

deleteLoadBalancerTlsCertificateResponse_operations :: Lens' DeleteLoadBalancerTlsCertificateResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

deleteLoadBalancerTlsCertificateResponse_httpStatus :: Lens' DeleteLoadBalancerTlsCertificateResponse Int Source #

The response's http status code.

TestAlarm

testAlarm_alarmName :: Lens' TestAlarm Text Source #

The name of the alarm to test.

testAlarm_state :: Lens' TestAlarm AlarmState Source #

The alarm state to test.

An alarm has the following possible states that can be tested:

ALARM - The metric is outside of the defined threshold.
INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
OK - The metric is within the defined threshold.

testAlarmResponse_operations :: Lens' TestAlarmResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

testAlarmResponse_httpStatus :: Lens' TestAlarmResponse Int Source #

The response's http status code.

GetDomains

getDomains_pageToken :: Lens' GetDomains (Maybe Text) Source #

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetDomains request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

getDomainsResponse_nextPageToken :: Lens' GetDomainsResponse (Maybe Text) Source #

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetDomains request and specify the next page token using the pageToken parameter.

getDomainsResponse_domains :: Lens' GetDomainsResponse (Maybe [Domain]) Source #

An array of key-value pairs containing information about each of the domain entries in the user's account.

getDomainsResponse_httpStatus :: Lens' GetDomainsResponse Int Source #

The response's http status code.

GetContainerImages

getContainerImages_serviceName :: Lens' GetContainerImages Text Source #

The name of the container service for which to return registered container images.

getContainerImagesResponse_containerImages :: Lens' GetContainerImagesResponse (Maybe [ContainerImage]) Source #

An array of objects that describe container images that are registered to the container service.

getContainerImagesResponse_httpStatus :: Lens' GetContainerImagesResponse Int Source #

The response's http status code.

UpdateRelationalDatabaseParameters

updateRelationalDatabaseParameters_relationalDatabaseName :: Lens' UpdateRelationalDatabaseParameters Text Source #

The name of your database for which to update parameters.

updateRelationalDatabaseParameters_parameters :: Lens' UpdateRelationalDatabaseParameters [RelationalDatabaseParameter] Source #

The database parameters to update.

updateRelationalDatabaseParametersResponse_operations :: Lens' UpdateRelationalDatabaseParametersResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

updateRelationalDatabaseParametersResponse_httpStatus :: Lens' UpdateRelationalDatabaseParametersResponse Int Source #

The response's http status code.

CreateLoadBalancerTlsCertificate

createLoadBalancerTlsCertificate_certificateAlternativeNames :: Lens' CreateLoadBalancerTlsCertificate (Maybe [Text]) Source #

An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g., *.example.com).

createLoadBalancerTlsCertificate_tags :: Lens' CreateLoadBalancerTlsCertificate (Maybe [Tag]) Source #

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

createLoadBalancerTlsCertificate_loadBalancerName :: Lens' CreateLoadBalancerTlsCertificate Text Source #

The load balancer name where you want to create the SSL/TLS certificate.

createLoadBalancerTlsCertificate_certificateName :: Lens' CreateLoadBalancerTlsCertificate Text Source #

The SSL/TLS certificate name.

You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits.

createLoadBalancerTlsCertificate_certificateDomainName :: Lens' CreateLoadBalancerTlsCertificate Text Source #

The domain name (e.g., example.com) for your SSL/TLS certificate.

createLoadBalancerTlsCertificateResponse_operations :: Lens' CreateLoadBalancerTlsCertificateResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

createLoadBalancerTlsCertificateResponse_httpStatus :: Lens' CreateLoadBalancerTlsCertificateResponse Int Source #

The response's http status code.

CreateDomainEntry

createDomainEntry_domainName :: Lens' CreateDomainEntry Text Source #

The domain name (e.g., example.com) for which you want to create the domain entry.

createDomainEntry_domainEntry :: Lens' CreateDomainEntry DomainEntry Source #

An array of key-value pairs containing information about the domain entry request.

createDomainEntryResponse_operation :: Lens' CreateDomainEntryResponse (Maybe Operation) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

createDomainEntryResponse_httpStatus :: Lens' CreateDomainEntryResponse Int Source #

The response's http status code.

GetContainerServicePowers

getContainerServicePowersResponse_powers :: Lens' GetContainerServicePowersResponse (Maybe [ContainerServicePower]) Source #

An array of objects that describe the powers that can be specified for a container service.

getContainerServicePowersResponse_httpStatus :: Lens' GetContainerServicePowersResponse Int Source #

The response's http status code.

ImportKeyPair

importKeyPair_keyPairName :: Lens' ImportKeyPair Text Source #

The name of the key pair for which you want to import the public key.

importKeyPair_publicKeyBase64 :: Lens' ImportKeyPair Text Source #

A base64-encoded public key of the ssh-rsa type.

importKeyPairResponse_operation :: Lens' ImportKeyPairResponse (Maybe Operation) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

importKeyPairResponse_httpStatus :: Lens' ImportKeyPairResponse Int Source #

The response's http status code.

GetInstanceSnapshots

getInstanceSnapshots_pageToken :: Lens' GetInstanceSnapshots (Maybe Text) Source #

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetInstanceSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

getInstanceSnapshotsResponse_nextPageToken :: Lens' GetInstanceSnapshotsResponse (Maybe Text) Source #

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetInstanceSnapshots request and specify the next page token using the pageToken parameter.

getInstanceSnapshotsResponse_instanceSnapshots :: Lens' GetInstanceSnapshotsResponse (Maybe [InstanceSnapshot]) Source #

An array of key-value pairs containing information about the results of your get instance snapshots request.

getInstanceSnapshotsResponse_httpStatus :: Lens' GetInstanceSnapshotsResponse Int Source #

The response's http status code.

ExportSnapshot

exportSnapshot_sourceSnapshotName :: Lens' ExportSnapshot Text Source #

The name of the instance or disk snapshot to be exported to Amazon EC2.

exportSnapshotResponse_operations :: Lens' ExportSnapshotResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

exportSnapshotResponse_httpStatus :: Lens' ExportSnapshotResponse Int Source #

The response's http status code.

CreateRelationalDatabaseFromSnapshot

createRelationalDatabaseFromSnapshot_sourceRelationalDatabaseName :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe Text) Source #

The name of the source database.

createRelationalDatabaseFromSnapshot_relationalDatabaseBundleId :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe Text) Source #

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.

createRelationalDatabaseFromSnapshot_publiclyAccessible :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe Bool) Source #

Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

createRelationalDatabaseFromSnapshot_useLatestRestorableTime :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe Bool) Source #

Specifies whether your database is restored from the latest backup time. A value of true restores from the latest backup time.

Default: false

Constraints: Cannot be specified if the restore time parameter is provided.

createRelationalDatabaseFromSnapshot_restoreTime :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe UTCTime) Source #

The date and time to restore your database from.

Constraints:

Must be before the latest restorable time for the database.
Cannot be specified if the use latest restorable time parameter is true.
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the restore time.

createRelationalDatabaseFromSnapshot_availabilityZone :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe Text) Source #

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

createRelationalDatabaseFromSnapshot_relationalDatabaseSnapshotName :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe Text) Source #

The name of the database snapshot from which to create your new database.

createRelationalDatabaseFromSnapshot_tags :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe [Tag]) Source #

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

createRelationalDatabaseFromSnapshot_relationalDatabaseName :: Lens' CreateRelationalDatabaseFromSnapshot Text Source #

The name to use for your new Lightsail database resource.

Constraints:

Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.

createRelationalDatabaseFromSnapshotResponse_operations :: Lens' CreateRelationalDatabaseFromSnapshotResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

createRelationalDatabaseFromSnapshotResponse_httpStatus :: Lens' CreateRelationalDatabaseFromSnapshotResponse Int Source #

The response's http status code.

CreateCloudFormationStack

createCloudFormationStack_instances :: Lens' CreateCloudFormationStack [InstanceEntry] Source #

An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry in this array.

createCloudFormationStackResponse_operations :: Lens' CreateCloudFormationStackResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

createCloudFormationStackResponse_httpStatus :: Lens' CreateCloudFormationStackResponse Int Source #

The response's http status code.

GetExportSnapshotRecords

getExportSnapshotRecords_pageToken :: Lens' GetExportSnapshotRecords (Maybe Text) Source #

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetExportSnapshotRecords request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

getExportSnapshotRecordsResponse_nextPageToken :: Lens' GetExportSnapshotRecordsResponse (Maybe Text) Source #

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetExportSnapshotRecords request and specify the next page token using the pageToken parameter.

getExportSnapshotRecordsResponse_exportSnapshotRecords :: Lens' GetExportSnapshotRecordsResponse (Maybe [ExportSnapshotRecord]) Source #

A list of objects describing the export snapshot records.

getExportSnapshotRecordsResponse_httpStatus :: Lens' GetExportSnapshotRecordsResponse Int Source #

The response's http status code.

ReleaseStaticIp

releaseStaticIp_staticIpName :: Lens' ReleaseStaticIp Text Source #

The name of the static IP to delete.

releaseStaticIpResponse_operations :: Lens' ReleaseStaticIpResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

releaseStaticIpResponse_httpStatus :: Lens' ReleaseStaticIpResponse Int Source #

The response's http status code.

DeleteInstance

deleteInstance_forceDeleteAddOns :: Lens' DeleteInstance (Maybe Bool) Source #

A Boolean value to indicate whether to delete the enabled add-ons for the disk.

deleteInstance_instanceName :: Lens' DeleteInstance Text Source #

The name of the instance to delete.

deleteInstanceResponse_operations :: Lens' DeleteInstanceResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

deleteInstanceResponse_httpStatus :: Lens' DeleteInstanceResponse Int Source #

The response's http status code.

CreateContainerServiceRegistryLogin

createContainerServiceRegistryLoginResponse_registryLogin :: Lens' CreateContainerServiceRegistryLoginResponse (Maybe ContainerServiceRegistryLogin) Source #

An object that describes the log in information for the container service registry of your Lightsail account.

createContainerServiceRegistryLoginResponse_httpStatus :: Lens' CreateContainerServiceRegistryLoginResponse Int Source #

The response's http status code.

GetCertificates

getCertificates_certificateStatuses :: Lens' GetCertificates (Maybe [CertificateStatus]) Source #

The status of the certificates for which to return information.

For example, specify ISSUED to return only certificates with an ISSUED status.

When omitted, the response includes all of your certificates in the AWS Region where the request is made, regardless of their current status.

getCertificates_certificateName :: Lens' GetCertificates (Maybe Text) Source #

The name for the certificate for which to return information.

When omitted, the response includes all of your certificates in the AWS Region where the request is made.

getCertificates_includeCertificateDetails :: Lens' GetCertificates (Maybe Bool) Source #

Indicates whether to include detailed information about the certificates in the response.

When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.

getCertificatesResponse_certificates :: Lens' GetCertificatesResponse (Maybe [CertificateSummary]) Source #

An object that describes certificates.

getCertificatesResponse_httpStatus :: Lens' GetCertificatesResponse Int Source #

The response's http status code.

GetContainerServiceMetricData

getContainerServiceMetricData_serviceName :: Lens' GetContainerServiceMetricData Text Source #

The name of the container service for which to get metric data.

getContainerServiceMetricData_metricName :: Lens' GetContainerServiceMetricData ContainerServiceMetricName Source #

The metric for which you want to return information.

Valid container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Percent.
MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Percent.

getContainerServiceMetricData_startTime :: Lens' GetContainerServiceMetricData UTCTime Source #

The start time of the time period.

getContainerServiceMetricData_endTime :: Lens' GetContainerServiceMetricData UTCTime Source #

The end time of the time period.

getContainerServiceMetricData_period :: Lens' GetContainerServiceMetricData Natural Source #

The granularity, in seconds, of the returned data points.

All container service metric data is available in 5-minute (300 seconds) granularity.

getContainerServiceMetricData_statistics :: Lens' GetContainerServiceMetricData [MetricStatistic] Source #

The statistic for the metric.

The following statistics are available:

Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
SampleCount - The count, or number, of data points used for the statistical calculation.

getContainerServiceMetricDataResponse_metricName :: Lens' GetContainerServiceMetricDataResponse (Maybe ContainerServiceMetricName) Source #

The name of the metric returned.

getContainerServiceMetricDataResponse_metricData :: Lens' GetContainerServiceMetricDataResponse (Maybe [MetricDatapoint]) Source #

An array of objects that describe the metric data returned.

getContainerServiceMetricDataResponse_httpStatus :: Lens' GetContainerServiceMetricDataResponse Int Source #

The response's http status code.

GetDistributionMetricData

getDistributionMetricData_distributionName :: Lens' GetDistributionMetricData Text Source #

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

getDistributionMetricData_metricName :: Lens' GetDistributionMetricData DistributionMetricName Source #

The metric for which you want to return information.

Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.
Statistics: The most useful statistic is Sum.
Unit: The published unit is None.
BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.
Statistics: The most useful statistic is Sum.
Unit: The published unit is None.
BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.
Statistics: The most useful statistic is Sum.
Unit: The published unit is None.
TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.
Statistics: The most useful statistic is Average.
Unit: The published unit is Percent.
4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.
Statistics: The most useful statistic is Average.
Unit: The published unit is Percent.
5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.
Statistics: The most useful statistic is Average.
Unit: The published unit is Percent.

getDistributionMetricData_startTime :: Lens' GetDistributionMetricData UTCTime Source #

The start of the time interval for which to get metric data.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

getDistributionMetricData_endTime :: Lens' GetDistributionMetricData UTCTime Source #

The end of the time interval for which to get metric data.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

getDistributionMetricData_period :: Lens' GetDistributionMetricData Natural Source #

The granularity, in seconds, for the metric data points that will be returned.

getDistributionMetricData_unit :: Lens' GetDistributionMetricData MetricUnit Source #

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

getDistributionMetricData_statistics :: Lens' GetDistributionMetricData [MetricStatistic] Source #

The statistic for the metric.

The following statistics are available:

Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
SampleCount - The count, or number, of data points used for the statistical calculation.

getDistributionMetricDataResponse_metricName :: Lens' GetDistributionMetricDataResponse (Maybe DistributionMetricName) Source #

The name of the metric returned.

getDistributionMetricDataResponse_metricData :: Lens' GetDistributionMetricDataResponse (Maybe [MetricDatapoint]) Source #

An array of objects that describe the metric data returned.

getDistributionMetricDataResponse_httpStatus :: Lens' GetDistributionMetricDataResponse Int Source #

The response's http status code.

RebootInstance

rebootInstance_instanceName :: Lens' RebootInstance Text Source #

The name of the instance to reboot.

rebootInstanceResponse_operations :: Lens' RebootInstanceResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

rebootInstanceResponse_httpStatus :: Lens' RebootInstanceResponse Int Source #

The response's http status code.

DeleteLoadBalancer

deleteLoadBalancer_loadBalancerName :: Lens' DeleteLoadBalancer Text Source #

The name of the load balancer you want to delete.

deleteLoadBalancerResponse_operations :: Lens' DeleteLoadBalancerResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

deleteLoadBalancerResponse_httpStatus :: Lens' DeleteLoadBalancerResponse Int Source #

The response's http status code.

CreateDiskFromSnapshot

createDiskFromSnapshot_useLatestRestorableAutoSnapshot :: Lens' CreateDiskFromSnapshot (Maybe Bool) Source #

A Boolean value to indicate whether to use the latest available automatic snapshot.

Constraints:

This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

createDiskFromSnapshot_sourceDiskName :: Lens' CreateDiskFromSnapshot (Maybe Text) Source #

The name of the source disk from which the source automatic snapshot was created.

Constraints:

This parameter cannot be defined together with the disk snapshot name parameter. The source disk name and disk snapshot name parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

createDiskFromSnapshot_addOns :: Lens' CreateDiskFromSnapshot (Maybe [AddOnRequest]) Source #

An array of objects that represent the add-ons to enable for the new disk.

createDiskFromSnapshot_diskSnapshotName :: Lens' CreateDiskFromSnapshot (Maybe Text) Source #

The name of the disk snapshot (e.g., my-snapshot) from which to create the new storage disk.

Constraint:

This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive.

createDiskFromSnapshot_restoreDate :: Lens' CreateDiskFromSnapshot (Maybe Text) Source #

The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

createDiskFromSnapshot_tags :: Lens' CreateDiskFromSnapshot (Maybe [Tag]) Source #

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

createDiskFromSnapshot_diskName :: Lens' CreateDiskFromSnapshot Text Source #

The unique Lightsail disk name (e.g., my-disk).

createDiskFromSnapshot_availabilityZone :: Lens' CreateDiskFromSnapshot Text Source #

The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.

Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.

createDiskFromSnapshot_sizeInGb :: Lens' CreateDiskFromSnapshot Int Source #

The size of the disk in GB (e.g., 32).

createDiskFromSnapshotResponse_operations :: Lens' CreateDiskFromSnapshotResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

createDiskFromSnapshotResponse_httpStatus :: Lens' CreateDiskFromSnapshotResponse Int Source #

The response's http status code.

GetRelationalDatabases

getRelationalDatabases_pageToken :: Lens' GetRelationalDatabases (Maybe Text) Source #

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabases request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

getRelationalDatabasesResponse_nextPageToken :: Lens' GetRelationalDatabasesResponse (Maybe Text) Source #

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetRelationalDatabases request and specify the next page token using the pageToken parameter.

getRelationalDatabasesResponse_relationalDatabases :: Lens' GetRelationalDatabasesResponse (Maybe [RelationalDatabase]) Source #

An object describing the result of your get relational databases request.

getRelationalDatabasesResponse_httpStatus :: Lens' GetRelationalDatabasesResponse Int Source #

The response's http status code.

GetInstanceSnapshot

getInstanceSnapshot_instanceSnapshotName :: Lens' GetInstanceSnapshot Text Source #

The name of the snapshot for which you are requesting information.

getInstanceSnapshotResponse_instanceSnapshot :: Lens' GetInstanceSnapshotResponse (Maybe InstanceSnapshot) Source #

An array of key-value pairs containing information about the results of your get instance snapshot request.

getInstanceSnapshotResponse_httpStatus :: Lens' GetInstanceSnapshotResponse Int Source #

The response's http status code.

GetRelationalDatabaseLogEvents

getRelationalDatabaseLogEvents_startTime :: Lens' GetRelationalDatabaseLogEvents (Maybe UTCTime) Source #

The start of the time interval from which to get log events.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

getRelationalDatabaseLogEvents_startFromHead :: Lens' GetRelationalDatabaseLogEvents (Maybe Bool) Source #

Parameter to specify if the log should start from head or tail. If true is specified, the log event starts from the head of the log. If false is specified, the log event starts from the tail of the log.

For PostgreSQL, the default value of false is the only option available.

getRelationalDatabaseLogEvents_endTime :: Lens' GetRelationalDatabaseLogEvents (Maybe UTCTime) Source #

The end of the time interval from which to get log events.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

getRelationalDatabaseLogEvents_pageToken :: Lens' GetRelationalDatabaseLogEvents (Maybe Text) Source #

The token to advance to the next or previous page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseLogEvents request. If your results are paginated, the response will return a next forward token and/or next backward token that you can specify as the page token in a subsequent request.

getRelationalDatabaseLogEvents_relationalDatabaseName :: Lens' GetRelationalDatabaseLogEvents Text Source #

The name of your database for which to get log events.

getRelationalDatabaseLogEvents_logStreamName :: Lens' GetRelationalDatabaseLogEvents Text Source #

The name of the log stream.

Use the get relational database log streams operation to get a list of available log streams.

getRelationalDatabaseLogEventsResponse_nextBackwardToken :: Lens' GetRelationalDatabaseLogEventsResponse (Maybe Text) Source #

A token used for advancing to the previous page of results from your get relational database log events request.

getRelationalDatabaseLogEventsResponse_resourceLogEvents :: Lens' GetRelationalDatabaseLogEventsResponse (Maybe [LogEvent]) Source #

An object describing the result of your get relational database log events request.

getRelationalDatabaseLogEventsResponse_nextForwardToken :: Lens' GetRelationalDatabaseLogEventsResponse (Maybe Text) Source #

A token used for advancing to the next page of results from your get relational database log events request.

getRelationalDatabaseLogEventsResponse_httpStatus :: Lens' GetRelationalDatabaseLogEventsResponse Int Source #

The response's http status code.

CreateContactMethod

createContactMethod_protocol :: Lens' CreateContactMethod ContactProtocol Source #

The protocol of the contact method, such as Email or SMS (text messaging).

The SMS protocol is supported only in the following AWS Regions.

US East (N. Virginia) (us-east-1)
US West (Oregon) (us-west-2)
Europe (Ireland) (eu-west-1)
Asia Pacific (Tokyo) (ap-northeast-1)
Asia Pacific (Singapore) (ap-southeast-1)
Asia Pacific (Sydney) (ap-southeast-2)

For a list of countries/regions where SMS text messages can be sent, and the latest AWS Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide.

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

createContactMethod_contactEndpoint :: Lens' CreateContactMethod Text Source #

The destination of the contact method, such as an email address or a mobile phone number.

Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are prefixed with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be specified as +1XXX5550100. For more information, see E.164 on Wikipedia.

createContactMethodResponse_operations :: Lens' CreateContactMethodResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

createContactMethodResponse_httpStatus :: Lens' CreateContactMethodResponse Int Source #

The response's http status code.

GetRelationalDatabaseLogStreams

getRelationalDatabaseLogStreams_relationalDatabaseName :: Lens' GetRelationalDatabaseLogStreams Text Source #

The name of your database for which to get log streams.

getRelationalDatabaseLogStreamsResponse_logStreams :: Lens' GetRelationalDatabaseLogStreamsResponse (Maybe [Text]) Source #

An object describing the result of your get relational database log streams request.

getRelationalDatabaseLogStreamsResponse_httpStatus :: Lens' GetRelationalDatabaseLogStreamsResponse Int Source #

The response's http status code.

GetDomain

getDomain_domainName :: Lens' GetDomain Text Source #

The domain name for which your want to return information about.

getDomainResponse_domain :: Lens' GetDomainResponse (Maybe Domain) Source #

An array of key-value pairs containing information about your get domain request.

getDomainResponse_httpStatus :: Lens' GetDomainResponse Int Source #

The response's http status code.

GetAutoSnapshots

getAutoSnapshots_resourceName :: Lens' GetAutoSnapshots Text Source #

The name of the source instance or disk from which to get automatic snapshot information.

getAutoSnapshotsResponse_resourceType :: Lens' GetAutoSnapshotsResponse (Maybe ResourceType) Source #

The resource type (e.g., Instance or Disk).

getAutoSnapshotsResponse_resourceName :: Lens' GetAutoSnapshotsResponse (Maybe Text) Source #

The name of the source instance or disk for the automatic snapshots.

getAutoSnapshotsResponse_autoSnapshots :: Lens' GetAutoSnapshotsResponse (Maybe [AutoSnapshotDetails]) Source #

An array of objects that describe the automatic snapshots that are available for the specified source instance or disk.

getAutoSnapshotsResponse_httpStatus :: Lens' GetAutoSnapshotsResponse Int Source #

The response's http status code.

GetActiveNames

getActiveNames_pageToken :: Lens' GetActiveNames (Maybe Text) Source #

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetActiveNames request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

getActiveNamesResponse_nextPageToken :: Lens' GetActiveNamesResponse (Maybe Text) Source #

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetActiveNames request and specify the next page token using the pageToken parameter.

getActiveNamesResponse_activeNames :: Lens' GetActiveNamesResponse (Maybe [Text]) Source #

The list of active names returned by the get active names request.

getActiveNamesResponse_httpStatus :: Lens' GetActiveNamesResponse Int Source #

The response's http status code.

DeleteContactMethod

deleteContactMethod_protocol :: Lens' DeleteContactMethod ContactProtocol Source #

The protocol that will be deleted, such as Email or SMS (text messaging).

To delete an Email and an SMS contact method if you added both, you must run separate DeleteContactMethod actions to delete each protocol.

deleteContactMethodResponse_operations :: Lens' DeleteContactMethodResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

deleteContactMethodResponse_httpStatus :: Lens' DeleteContactMethodResponse Int Source #

The response's http status code.

CreateDistribution

createDistribution_cacheBehaviorSettings :: Lens' CreateDistribution (Maybe CacheSettings) Source #

An object that describes the cache behavior settings for the distribution.

createDistribution_ipAddressType :: Lens' CreateDistribution (Maybe IpAddressType) Source #

The IP address type for the distribution.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

The default value is dualstack.

createDistribution_cacheBehaviors :: Lens' CreateDistribution (Maybe [CacheBehaviorPerPath]) Source #

An array of objects that describe the per-path cache behavior for the distribution.

createDistribution_tags :: Lens' CreateDistribution (Maybe [Tag]) Source #

The tag keys and optional values to add to the distribution during create.

Use the TagResource action to tag a resource after it's created.

createDistribution_distributionName :: Lens' CreateDistribution Text Source #

The name for the distribution.

createDistribution_origin :: Lens' CreateDistribution InputOrigin Source #

An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.

The distribution pulls, caches, and serves content from the origin.

createDistribution_defaultCacheBehavior :: Lens' CreateDistribution CacheBehavior Source #

An object that describes the default cache behavior for the distribution.

createDistribution_bundleId :: Lens' CreateDistribution Text Source #

The bundle ID to use for the distribution.

A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.

Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.

createDistributionResponse_distribution :: Lens' CreateDistributionResponse (Maybe LightsailDistribution) Source #

An object that describes the distribution created.

createDistributionResponse_operation :: Lens' CreateDistributionResponse (Maybe Operation) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

createDistributionResponse_httpStatus :: Lens' CreateDistributionResponse Int Source #

The response's http status code.

StopRelationalDatabase

stopRelationalDatabase_relationalDatabaseSnapshotName :: Lens' StopRelationalDatabase (Maybe Text) Source #

The name of your new database snapshot to be created before stopping your database.

stopRelationalDatabase_relationalDatabaseName :: Lens' StopRelationalDatabase Text Source #

The name of your database to stop.

stopRelationalDatabaseResponse_operations :: Lens' StopRelationalDatabaseResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

stopRelationalDatabaseResponse_httpStatus :: Lens' StopRelationalDatabaseResponse Int Source #

The response's http status code.

CreateRelationalDatabaseSnapshot

createRelationalDatabaseSnapshot_tags :: Lens' CreateRelationalDatabaseSnapshot (Maybe [Tag]) Source #

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

createRelationalDatabaseSnapshot_relationalDatabaseName :: Lens' CreateRelationalDatabaseSnapshot Text Source #

The name of the database on which to base your new snapshot.

createRelationalDatabaseSnapshot_relationalDatabaseSnapshotName :: Lens' CreateRelationalDatabaseSnapshot Text Source #

The name for your new database snapshot.

Constraints:

Must contain from 2 to 255 alphanumeric characters, or hyphens.
The first and last character must be a letter or number.

createRelationalDatabaseSnapshotResponse_operations :: Lens' CreateRelationalDatabaseSnapshotResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

createRelationalDatabaseSnapshotResponse_httpStatus :: Lens' CreateRelationalDatabaseSnapshotResponse Int Source #

The response's http status code.

DetachCertificateFromDistribution

detachCertificateFromDistribution_distributionName :: Lens' DetachCertificateFromDistribution Text Source #

The name of the distribution from which to detach the certificate.

Use the GetDistributions action to get a list of distribution names that you can specify.

detachCertificateFromDistributionResponse_operation :: Lens' DetachCertificateFromDistributionResponse (Maybe Operation) Source #

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

detachCertificateFromDistributionResponse_httpStatus :: Lens' DetachCertificateFromDistributionResponse Int Source #

The response's http status code.

CreateContainerService

createContainerService_publicDomainNames :: Lens' CreateContainerService (Maybe (HashMap Text [Text])) Source #

The public domain names to use with the container service, such as example.com and www.example.com.

You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.

If you don't specify public domain names, then you can use the default domain of the container service.

You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

You can specify public domain names using a string to array map as shown in the example later on this page.

createContainerService_tags :: Lens' CreateContainerService (Maybe [Tag]) Source #

The tag keys and optional values to add to the certificate during create.

Use the TagResource action to tag a resource after it's created.

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

createContainerService_deployment :: Lens' CreateContainerService (Maybe ContainerServiceDeploymentRequest) Source #

An object that describes a deployment for the container service.

A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

createContainerService_serviceName :: Lens' CreateContainerService Text Source #

The name for the container service.

The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com. If the name of your container service is container-service-1, and it's located in the US East (Ohio) AWS region (us-east-2), then the domain for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com

The following are the requirements for container service names:

Must be unique within each AWS Region in your Lightsail account.
Must contain 1 to 63 characters.
Must contain only alphanumeric characters and hyphens.
A hyphen (-) can separate words but cannot be at the start or end of the name.

createContainerService_power :: Lens' CreateContainerService ContainerServicePowerName Source #

The power specification for the container service.

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Use the GetContainerServicePowers action to get a list of power options that you can specify using this parameter, and their base monthly cost.

createContainerService_scale :: Lens' CreateContainerService Natural Source #

The scale specification for the container service.

The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

createContainerServiceResponse_containerService :: Lens' CreateContainerServiceResponse (Maybe ContainerService) Source #

An object that describes a container service.

createContainerServiceResponse_httpStatus :: Lens' CreateContainerServiceResponse Int Source #

The response's http status code.

GetInstanceAccessDetails

getInstanceAccessDetails_protocol :: Lens' GetInstanceAccessDetails (Maybe InstanceAccessProtocol) Source #

The protocol to use to connect to your instance. Defaults to ssh.

getInstanceAccessDetails_instanceName :: Lens' GetInstanceAccessDetails Text Source #

The name of the instance to access.

getInstanceAccessDetailsResponse_accessDetails :: Lens' GetInstanceAccessDetailsResponse (Maybe InstanceAccessDetails) Source #

An array of key-value pairs containing information about a get instance access request.

getInstanceAccessDetailsResponse_httpStatus :: Lens' GetInstanceAccessDetailsResponse Int Source #

The response's http status code.

EnableAddOn

enableAddOn_resourceName :: Lens' EnableAddOn Text Source #

The name of the source resource for which to enable or modify the add-on.

enableAddOn_addOnRequest :: Lens' EnableAddOn AddOnRequest Source #

An array of strings representing the add-on to enable or modify.

enableAddOnResponse_operations :: Lens' EnableAddOnResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

enableAddOnResponse_httpStatus :: Lens' EnableAddOnResponse Int Source #

The response's http status code.

StopInstance

stopInstance_force :: Lens' StopInstance (Maybe Bool) Source #

When set to True, forces a Lightsail instance that is stuck in a stopping state to stop.

Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request.

stopInstance_instanceName :: Lens' StopInstance Text Source #

The name of the instance (a virtual private server) to stop.

stopInstanceResponse_operations :: Lens' StopInstanceResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

stopInstanceResponse_httpStatus :: Lens' StopInstanceResponse Int Source #

The response's http status code.

DetachInstancesFromLoadBalancer

detachInstancesFromLoadBalancer_loadBalancerName :: Lens' DetachInstancesFromLoadBalancer Text Source #

The name of the Lightsail load balancer.

detachInstancesFromLoadBalancer_instanceNames :: Lens' DetachInstancesFromLoadBalancer [Text] Source #

An array of strings containing the names of the instances you want to detach from the load balancer.

detachInstancesFromLoadBalancerResponse_operations :: Lens' DetachInstancesFromLoadBalancerResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

detachInstancesFromLoadBalancerResponse_httpStatus :: Lens' DetachInstancesFromLoadBalancerResponse Int Source #

The response's http status code.

RegisterContainerImage

registerContainerImage_serviceName :: Lens' RegisterContainerImage Text Source #

The name of the container service for which to register a container image.

registerContainerImage_label :: Lens' RegisterContainerImage Text Source #

The label for the container image when it's registered to the container service.

Use a descriptive label that you can use to track the different versions of your registered container images.

Use the GetContainerImages action to return the container images registered to a Lightsail container service. The label is the <imagelabel> portion of the following image name example:

```
:container-service-1.<imagelabel>.1
```

If the name of your container service is mycontainerservice, and the label that you specify is mystaticwebsite, then the name of the registered container image will be :mycontainerservice.mystaticwebsite.1.

The number at the end of these image name examples represents the version of the registered container image. If you push and register another container image to the same Lightsail container service, with the same label, then the version number for the new registered container image will be 2. If you push and register another container image, the version number will be 3, and so on.

registerContainerImage_digest :: Lens' RegisterContainerImage Text Source #

The digest of the container image to be registered.

registerContainerImageResponse_containerImage :: Lens' RegisterContainerImageResponse (Maybe ContainerImage) Source #

Undocumented member.

registerContainerImageResponse_httpStatus :: Lens' RegisterContainerImageResponse Int Source #

The response's http status code.

CreateCertificate

createCertificate_subjectAlternativeNames :: Lens' CreateCertificate (Maybe [Text]) Source #

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.

You can specify a maximum of nine alternate domains (in addition to the primary domain name).

Wildcard domain entries (e.g., *.example.com) are not supported.

createCertificate_tags :: Lens' CreateCertificate (Maybe [Tag]) Source #

The tag keys and optional values to add to the certificate during create.

Use the TagResource action to tag a resource after it's created.

createCertificate_certificateName :: Lens' CreateCertificate Text Source #

The name for the certificate.

createCertificate_domainName :: Lens' CreateCertificate Text Source #

The domain name (e.g., example.com) for the certificate.

createCertificateResponse_certificate :: Lens' CreateCertificateResponse (Maybe CertificateSummary) Source #

An object that describes the certificate created.

createCertificateResponse_operations :: Lens' CreateCertificateResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

createCertificateResponse_httpStatus :: Lens' CreateCertificateResponse Int Source #

The response's http status code.

CreateInstanceSnapshot

createInstanceSnapshot_tags :: Lens' CreateInstanceSnapshot (Maybe [Tag]) Source #

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

createInstanceSnapshot_instanceSnapshotName :: Lens' CreateInstanceSnapshot Text Source #

The name for your new snapshot.

createInstanceSnapshot_instanceName :: Lens' CreateInstanceSnapshot Text Source #

The Lightsail instance on which to base your snapshot.

createInstanceSnapshotResponse_operations :: Lens' CreateInstanceSnapshotResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

createInstanceSnapshotResponse_httpStatus :: Lens' CreateInstanceSnapshotResponse Int Source #

The response's http status code.

CopySnapshot

copySnapshot_useLatestRestorableAutoSnapshot :: Lens' CopySnapshot (Maybe Bool) Source #

A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.

Constraints:

This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.

copySnapshot_restoreDate :: Lens' CopySnapshot (Maybe Text) Source #

The date of the source automatic snapshot to copy. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.

copySnapshot_sourceResourceName :: Lens' CopySnapshot (Maybe Text) Source #

The name of the source instance or disk from which the source automatic snapshot was created.

Constraint:

Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.

copySnapshot_sourceSnapshotName :: Lens' CopySnapshot (Maybe Text) Source #

The name of the source manual snapshot to copy.

Constraint:

Define this parameter only when copying a manual snapshot as another manual snapshot.

copySnapshot_targetSnapshotName :: Lens' CopySnapshot Text Source #

The name of the new manual snapshot to be created as a copy.

copySnapshot_sourceRegion :: Lens' CopySnapshot RegionName Source #

The AWS Region where the source manual or automatic snapshot is located.

copySnapshotResponse_operations :: Lens' CopySnapshotResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

copySnapshotResponse_httpStatus :: Lens' CopySnapshotResponse Int Source #

The response's http status code.

GetRelationalDatabaseSnapshot

getRelationalDatabaseSnapshot_relationalDatabaseSnapshotName :: Lens' GetRelationalDatabaseSnapshot Text Source #

The name of the database snapshot for which to get information.

getRelationalDatabaseSnapshotResponse_relationalDatabaseSnapshot :: Lens' GetRelationalDatabaseSnapshotResponse (Maybe RelationalDatabaseSnapshot) Source #

An object describing the specified database snapshot.

getRelationalDatabaseSnapshotResponse_httpStatus :: Lens' GetRelationalDatabaseSnapshotResponse Int Source #

The response's http status code.

IsVpcPeered

isVpcPeeredResponse_isPeered :: Lens' IsVpcPeeredResponse (Maybe Bool) Source #

Returns true if the Lightsail VPC is peered; otherwise, false.

isVpcPeeredResponse_httpStatus :: Lens' IsVpcPeeredResponse Int Source #

The response's http status code.

GetStaticIps

getStaticIps_pageToken :: Lens' GetStaticIps (Maybe Text) Source #

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetStaticIps request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

getStaticIpsResponse_nextPageToken :: Lens' GetStaticIpsResponse (Maybe Text) Source #

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetStaticIps request and specify the next page token using the pageToken parameter.

getStaticIpsResponse_staticIps :: Lens' GetStaticIpsResponse (Maybe [StaticIp]) Source #

An array of key-value pairs containing information about your get static IPs request.

getStaticIpsResponse_httpStatus :: Lens' GetStaticIpsResponse Int Source #

The response's http status code.

UnpeerVpc

unpeerVpcResponse_operation :: Lens' UnpeerVpcResponse (Maybe Operation) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

unpeerVpcResponse_httpStatus :: Lens' UnpeerVpcResponse Int Source #

The response's http status code.

DeleteDisk

deleteDisk_forceDeleteAddOns :: Lens' DeleteDisk (Maybe Bool) Source #

A Boolean value to indicate whether to delete the enabled add-ons for the disk.

deleteDisk_diskName :: Lens' DeleteDisk Text Source #

The unique name of the disk you want to delete (e.g., my-disk).

deleteDiskResponse_operations :: Lens' DeleteDiskResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

deleteDiskResponse_httpStatus :: Lens' DeleteDiskResponse Int Source #

The response's http status code.

CreateInstancesFromSnapshot

createInstancesFromSnapshot_useLatestRestorableAutoSnapshot :: Lens' CreateInstancesFromSnapshot (Maybe Bool) Source #

A Boolean value to indicate whether to use the latest available automatic snapshot.

Constraints:

This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

createInstancesFromSnapshot_instanceSnapshotName :: Lens' CreateInstancesFromSnapshot (Maybe Text) Source #

The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.

Constraint:

This parameter cannot be defined together with the source instance name parameter. The instance snapshot name and source instance name parameters are mutually exclusive.

createInstancesFromSnapshot_addOns :: Lens' CreateInstancesFromSnapshot (Maybe [AddOnRequest]) Source #

An array of objects representing the add-ons to enable for the new instance.

createInstancesFromSnapshot_userData :: Lens' CreateInstancesFromSnapshot (Maybe Text) Source #

You can create a launch script that configures a server with additional user data. For example, apt-get -y update.

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.

createInstancesFromSnapshot_restoreDate :: Lens' CreateInstancesFromSnapshot (Maybe Text) Source #

The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

createInstancesFromSnapshot_ipAddressType :: Lens' CreateInstancesFromSnapshot (Maybe IpAddressType) Source #

The IP address type for the instance.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

The default value is dualstack.