@aws-sdk/client-lightsail 3.241.0 → 3.252.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/README.md +0 -2
  2. package/dist-cjs/endpoint/ruleset.js +3 -3
  3. package/dist-cjs/protocols/Aws_json1_1.js +17 -17
  4. package/dist-es/endpoint/ruleset.js +3 -3
  5. package/dist-es/protocols/Aws_json1_1.js +17 -17
  6. package/dist-types/Lightsail.d.ts +0 -41
  7. package/dist-types/LightsailClient.d.ts +0 -2
  8. package/dist-types/commands/CreateBucketAccessKeyCommand.d.ts +0 -2
  9. package/dist-types/commands/CreateBucketCommand.d.ts +0 -1
  10. package/dist-types/commands/CreateContainerServiceCommand.d.ts +0 -1
  11. package/dist-types/commands/CreateContainerServiceDeploymentCommand.d.ts +0 -2
  12. package/dist-types/commands/CreateContainerServiceRegistryLoginCommand.d.ts +0 -3
  13. package/dist-types/commands/CreateDiskSnapshotCommand.d.ts +0 -1
  14. package/dist-types/commands/CreateDomainEntryCommand.d.ts +0 -3
  15. package/dist-types/commands/DeleteBucketAccessKeyCommand.d.ts +0 -2
  16. package/dist-types/commands/DeleteBucketCommand.d.ts +0 -1
  17. package/dist-types/commands/DeleteKeyPairCommand.d.ts +0 -1
  18. package/dist-types/commands/GetBucketAccessKeysCommand.d.ts +0 -1
  19. package/dist-types/commands/GetBucketBundlesCommand.d.ts +0 -2
  20. package/dist-types/commands/GetBucketMetricDataCommand.d.ts +0 -1
  21. package/dist-types/commands/GetBucketsCommand.d.ts +0 -1
  22. package/dist-types/commands/GetBundlesCommand.d.ts +0 -2
  23. package/dist-types/commands/GetContainerImagesCommand.d.ts +0 -1
  24. package/dist-types/commands/GetContainerLogCommand.d.ts +0 -2
  25. package/dist-types/commands/GetContainerServiceDeploymentsCommand.d.ts +0 -3
  26. package/dist-types/commands/GetContainerServiceMetricDataCommand.d.ts +0 -1
  27. package/dist-types/commands/GetContainerServicePowersCommand.d.ts +0 -1
  28. package/dist-types/commands/GetLoadBalancerTlsPoliciesCommand.d.ts +0 -1
  29. package/dist-types/commands/RegisterContainerImageCommand.d.ts +0 -1
  30. package/dist-types/commands/SetIpAddressTypeCommand.d.ts +0 -1
  31. package/dist-types/commands/SetResourceAccessForBucketCommand.d.ts +0 -1
  32. package/dist-types/commands/UpdateBucketBundleCommand.d.ts +0 -2
  33. package/dist-types/commands/UpdateBucketCommand.d.ts +0 -1
  34. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  35. package/dist-types/models/models_0.d.ts +2 -128
  36. package/dist-types/models/models_1.d.ts +0 -40
  37. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  38. package/package.json +5 -5
@@ -9,13 +9,11 @@ export interface CreateContainerServiceDeploymentCommandOutput extends CreateCon
9
9
  }
10
10
  /**
11
11
  * <p>Creates a deployment for your Amazon Lightsail container service.</p>
12
- *
13
12
  * <p>A deployment specifies the containers that will be launched on the container service and
14
13
  * their settings, such as the ports to open, the environment variables to apply, and the launch
15
14
  * command to run. It also specifies the container that will serve as the public endpoint of the
16
15
  * deployment and its settings, such as the HTTP or HTTPS port to use, and the health check
17
16
  * configuration.</p>
18
- *
19
17
  * <p>You can deploy containers to your container service using container images from a public
20
18
  * registry such as Amazon ECR Public, or from your local machine. For more information, see
21
19
  * <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-container-images">Creating container images for your Amazon Lightsail container services</a> in the
@@ -14,17 +14,14 @@ export interface CreateContainerServiceRegistryLoginCommandOutput extends Create
14
14
  * account so that you can use them with your Lightsail container service. The log in
15
15
  * credentials expire 12 hours after they are created, at which point you will need to create a
16
16
  * new set of log in credentials.</p>
17
- *
18
17
  * <note>
19
18
  * <p>You can only push container images to the container service registry of your Lightsail
20
19
  * account. You cannot pull container images or perform any other container image management
21
20
  * actions on the container service registry.</p>
22
21
  * </note>
23
- *
24
22
  * <p>After you push your container images to the container image registry of your Lightsail
25
23
  * account, use the <code>RegisterContainerImage</code> action to register the pushed images to a
26
24
  * specific Lightsail container service.</p>
27
- *
28
25
  * <note>
29
26
  * <p>This action is not required if you install and use the Lightsail Control
30
27
  * (lightsailctl) plugin to push container images to your Lightsail container service. For
@@ -25,7 +25,6 @@ export interface CreateDiskSnapshotCommandOutput extends CreateDiskSnapshotResul
25
25
  * when issuing the snapshot command, and a snapshot of the defined instance's system volume will
26
26
  * be created. After the snapshot is available, you can create a block storage disk from the
27
27
  * snapshot and attach it to a running instance to access the data on the disk.</p>
28
- *
29
28
  * <p>The <code>create disk snapshot</code> operation supports tag-based access control via
30
29
  * request tags. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags">Amazon Lightsail Developer Guide</a>.</p>
31
30
  * @example
@@ -11,9 +11,6 @@ export interface CreateDomainEntryCommandOutput extends CreateDomainEntryResult,
11
11
  * <p>Creates one of the following domain name system (DNS) records in a domain DNS zone:
12
12
  * Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority
13
13
  * (SOA), service locator (SRV), or text (TXT).</p>
14
- *
15
- *
16
- *
17
14
  * <p>The <code>create domain entry</code> operation supports tag-based access control via
18
15
  * resource tags applied to the resource identified by <code>domain name</code>. For more
19
16
  * information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags">Amazon Lightsail Developer Guide</a>.</p>
@@ -9,9 +9,7 @@ export interface DeleteBucketAccessKeyCommandOutput extends DeleteBucketAccessKe
9
9
  }
10
10
  /**
11
11
  * <p>Deletes an access key for the specified Amazon Lightsail bucket.</p>
12
- *
13
12
  * <p>We recommend that you delete an access key if the secret access key is compromised.</p>
14
- *
15
13
  * <p>For more information about access keys, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys">Creating access keys for a bucket in Amazon Lightsail</a> in the
16
14
  * <i>Amazon Lightsail Developer Guide</i>.</p>
17
15
  * @example
@@ -9,7 +9,6 @@ export interface DeleteBucketCommandOutput extends DeleteBucketResult, __Metadat
9
9
  }
10
10
  /**
11
11
  * <p>Deletes a Amazon Lightsail bucket.</p>
12
- *
13
12
  * <note>
14
13
  * <p>When you delete your bucket, the bucket name is released and can be reused for a new
15
14
  * bucket in your account or another Amazon Web Services account.</p>
@@ -13,7 +13,6 @@ export interface DeleteKeyPairCommandOutput extends DeleteKeyPairResult, __Metad
13
13
  * <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateKeyPair.html">CreateKeyPair</a> actions, as well as the Lightsail default key pair. A new default
14
14
  * key pair will not be created unless you launch an instance without specifying a custom key
15
15
  * pair, or you call the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html">DownloadDefaultKeyPair</a> API. </p>
16
- *
17
16
  * <p>The <code>delete key pair</code> operation supports tag-based access control via resource
18
17
  * tags applied to the resource identified by <code>key pair name</code>. For more information,
19
18
  * see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags">Amazon Lightsail Developer Guide</a>.</p>
@@ -9,7 +9,6 @@ export interface GetBucketAccessKeysCommandOutput extends GetBucketAccessKeysRes
9
9
  }
10
10
  /**
11
11
  * <p>Returns the existing access key IDs for the specified Amazon Lightsail bucket.</p>
12
- *
13
12
  * <important>
14
13
  * <p>This action does not return the secret access key value of an access key. You can get a
15
14
  * secret access key only when you create it from the response of the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html">CreateBucketAccessKey</a> action. If you lose the secret access key, you must create
@@ -9,10 +9,8 @@ export interface GetBucketBundlesCommandOutput extends GetBucketBundlesResult, _
9
9
  }
10
10
  /**
11
11
  * <p>Returns the bundles that you can apply to a Amazon Lightsail bucket.</p>
12
- *
13
12
  * <p>The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a
14
13
  * bucket.</p>
15
- *
16
14
  * <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html">UpdateBucketBundle</a> action to update the
17
15
  * bundle for a bucket.</p>
18
16
  * @example
@@ -9,7 +9,6 @@ export interface GetBucketMetricDataCommandOutput extends GetBucketMetricDataRes
9
9
  }
10
10
  /**
11
11
  * <p>Returns the data points of a specific metric for an Amazon Lightsail bucket.</p>
12
- *
13
12
  * <p>Metrics report the utilization of a bucket. View and collect metric data regularly to
14
13
  * monitor the number of objects stored in a bucket (including object versions) and the storage
15
14
  * space used by those objects.</p>
@@ -11,7 +11,6 @@ export interface GetBucketsCommandOutput extends GetBucketsResult, __MetadataBea
11
11
  * <p>Returns information about one or more Amazon Lightsail buckets. The information returned
12
12
  * includes the synchronization status of the Amazon Simple Storage Service (Amazon S3)
13
13
  * account-level block public access feature for your Lightsail buckets.</p>
14
- *
15
14
  * <p>For more information about buckets, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail">Buckets in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer
16
15
  * Guide</i>.</p>
17
16
  * @example
@@ -10,11 +10,9 @@ export interface GetBundlesCommandOutput extends GetBundlesResult, __MetadataBea
10
10
  /**
11
11
  * <p>Returns the bundles that you can apply to an Amazon Lightsail instance when you create
12
12
  * it.</p>
13
- *
14
13
  * <p>A bundle describes the specifications of an instance, such as the monthly cost, amount of
15
14
  * memory, the number of vCPUs, amount of storage space, and monthly network data transfer
16
15
  * quota.</p>
17
- *
18
16
  * <note>
19
17
  * <p>Bundles are referred to as <i>instance plans</i> in the Lightsail
20
18
  * console.</p>
@@ -10,7 +10,6 @@ export interface GetContainerImagesCommandOutput extends GetContainerImagesResul
10
10
  /**
11
11
  * <p>Returns the container images that are registered to your Amazon Lightsail container
12
12
  * service.</p>
13
- *
14
13
  * <note>
15
14
  * <p>If you created a deployment on your Lightsail container service that uses container
16
15
  * images from a public registry like Docker Hub, those images are not returned as part of this
@@ -9,11 +9,9 @@ export interface GetContainerLogCommandOutput extends GetContainerLogResult, __M
9
9
  }
10
10
  /**
11
11
  * <p>Returns the log events of a container of your Amazon Lightsail container service.</p>
12
- *
13
12
  * <p>If your container service has more than one node (i.e., a scale greater than 1), then the
14
13
  * log events that are returned for the specified container are merged from all nodes on your
15
14
  * container service.</p>
16
- *
17
15
  * <note>
18
16
  * <p>Container logs are retained for a certain amount of time. For more information, see
19
17
  * <a href="https://docs.aws.amazon.com/general/latest/gr/lightsail.html">Amazon Lightsail
@@ -9,13 +9,10 @@ export interface GetContainerServiceDeploymentsCommandOutput extends GetContaine
9
9
  }
10
10
  /**
11
11
  * <p>Returns the deployments for your Amazon Lightsail container service</p>
12
- *
13
12
  * <p>A deployment specifies the settings, such as the ports and launch command, of containers
14
13
  * that are deployed to your container service.</p>
15
- *
16
14
  * <p>The deployments are ordered by version in ascending order. The newest version is listed at
17
15
  * the top of the response.</p>
18
- *
19
16
  * <note>
20
17
  * <p>A set number of deployments are kept before the oldest one is replaced with the newest
21
18
  * one. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/lightsail.html">Amazon Lightsail
@@ -10,7 +10,6 @@ export interface GetContainerServiceMetricDataCommandOutput extends GetContainer
10
10
  /**
11
11
  * <p>Returns the data points of a specific metric of your Amazon Lightsail container
12
12
  * service.</p>
13
- *
14
13
  * <p>Metrics report the utilization of your resources. Monitor and collect metric data
15
14
  * regularly to maintain the reliability, availability, and performance of your resources.</p>
16
15
  * @example
@@ -10,7 +10,6 @@ export interface GetContainerServicePowersCommandOutput extends GetContainerServ
10
10
  /**
11
11
  * <p>Returns the list of powers that can be specified for your Amazon Lightsail container
12
12
  * services.</p>
13
- *
14
13
  * <p>The power specifies the amount of memory, the number of vCPUs, and the base price of the
15
14
  * container service.</p>
16
15
  * @example
@@ -10,7 +10,6 @@ export interface GetLoadBalancerTlsPoliciesCommandOutput extends GetLoadBalancer
10
10
  /**
11
11
  * <p>Returns a list of TLS security policies that you can apply to Lightsail load
12
12
  * balancers.</p>
13
- *
14
13
  * <p>For more information about load balancer TLS security policies, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy">Configuring TLS security policies on your Amazon Lightsail load
15
14
  * balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>
16
15
  * @example
@@ -9,7 +9,6 @@ export interface RegisterContainerImageCommandOutput extends RegisterContainerIm
9
9
  }
10
10
  /**
11
11
  * <p>Registers a container image to your Amazon Lightsail container service.</p>
12
- *
13
12
  * <note>
14
13
  * <p>This action is not required if you install and use the Lightsail Control
15
14
  * (lightsailctl) plugin to push container images to your Lightsail container service. For
@@ -9,7 +9,6 @@ export interface SetIpAddressTypeCommandOutput extends SetIpAddressTypeResult, _
9
9
  }
10
10
  /**
11
11
  * <p>Sets the IP address type for an Amazon Lightsail resource.</p>
12
- *
13
12
  * <p>Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the
14
13
  * specified resource. Alternately, you can use this action to disable dual-stack, and enable
15
14
  * IPv4 only.</p>
@@ -10,7 +10,6 @@ export interface SetResourceAccessForBucketCommandOutput extends SetResourceAcce
10
10
  /**
11
11
  * <p>Sets the Amazon Lightsail resources that can access the specified Lightsail
12
12
  * bucket.</p>
13
- *
14
13
  * <p>Lightsail buckets currently support setting access for Lightsail instances in the same
15
14
  * Amazon Web Services Region.</p>
16
15
  * @example
@@ -9,13 +9,11 @@ export interface UpdateBucketBundleCommandOutput extends UpdateBucketBundleResul
9
9
  }
10
10
  /**
11
11
  * <p>Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.</p>
12
- *
13
12
  * <p>A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a
14
13
  * bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services
15
14
  * billing cycle. To determine if you can update a bucket's bundle, use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html">GetBuckets</a> action. The
16
15
  * <code>ableToUpdateBundle</code> parameter in the response will indicate whether you can
17
16
  * currently update a bucket's bundle.</p>
18
- *
19
17
  * <p>Update a bucket's bundle if it's consistently going over its storage space or data
20
18
  * transfer quota, or if a bucket's usage is consistently in the lower range of its storage space
21
19
  * or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might
@@ -9,7 +9,6 @@ export interface UpdateBucketCommandOutput extends UpdateBucketResult, __Metadat
9
9
  }
10
10
  /**
11
11
  * <p>Updates an existing Amazon Lightsail bucket.</p>
12
- *
13
12
  * <p>Use this action to update the configuration of an existing bucket, such as versioning,
14
13
  * public accessibility, and the Amazon Web Services accounts that can access the bucket.</p>
15
14
  * @example
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region?: string;
15
+ Region: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;