docs(client-lightsail): Documentation updates for Amazon Lightsail.

aws · Jan 5, 2023 · d7ca5a7 · d7ca5a7
1 parent 5316f31
commit d7ca5a7
Show file tree

Hide file tree

Showing 33 changed files with 21 additions and 271 deletions.
diff --git a/clients/client-lightsail/README.md b/clients/client-lightsail/README.md
@@ -15,11 +15,9 @@ container services, storage buckets, managed databases, SSD-based block storage,
 addresses, load balancers, content delivery network (CDN) distributions, DNS management of
 registered domains, and resource snapshots (backups) - for a low, predictable monthly
 price.</p>
-
 <p>You can manage your Lightsail resources using the Lightsail console, Lightsail API,
 Command Line Interface (CLI), or SDKs. For more information about Lightsail
 concepts and tasks, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-set-up-access-keys-to-use-sdk-api-cli">Amazon Lightsail Developer Guide</a>.</p>
-
 <p>This API Reference provides detailed information about the actions, data types,
 parameters, and errors of the Lightsail service. For more information about the supported
 Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see

diff --git a/clients/client-lightsail/src/Lightsail.ts b/clients/client-lightsail/src/Lightsail.ts
diff --git a/clients/client-lightsail/src/LightsailClient.ts b/clients/client-lightsail/src/LightsailClient.ts
@@ -911,11 +911,9 @@ export interface LightsailClientResolvedConfig extends LightsailClientResolvedCo
  *       addresses, load balancers, content delivery network (CDN) distributions, DNS management of
  *       registered domains, and resource snapshots (backups) - for a low, predictable monthly
  *       price.</p>
- *
  *          <p>You can manage your Lightsail resources using the Lightsail console, Lightsail API,
  *         Command Line Interface (CLI), or SDKs. For more information about Lightsail
  *       concepts and tasks, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-set-up-access-keys-to-use-sdk-api-cli">Amazon Lightsail Developer Guide</a>.</p>
- *
  *          <p>This API Reference provides detailed information about the actions, data types,
  *       parameters, and errors of the Lightsail service. For more information about the supported
  *         Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see

diff --git a/clients/client-lightsail/src/commands/CreateBucketAccessKeyCommand.ts b/clients/client-lightsail/src/commands/CreateBucketAccessKeyCommand.ts
@@ -31,12 +31,10 @@ export interface CreateBucketAccessKeyCommandOutput extends CreateBucketAccessKe
 /**
  * <p>Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of
  *       an access key ID and corresponding secret access key.</p>
- *
  *          <p>Access keys grant full programmatic access to the specified bucket and its objects. You
  *       can have a maximum of two access keys per bucket. Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html">GetBucketAccessKeys</a> action to get a list of current access keys for a specific bucket. 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
  *         <i>Amazon Lightsail Developer Guide</i>.</p>
- *
  *          <important>
  *             <p>The <code>secretAccessKey</code> value is returned only in response to the
  *           <code>CreateBucketAccessKey</code> action. You can get a secret access key only when you

diff --git a/clients/client-lightsail/src/commands/CreateBucketCommand.ts b/clients/client-lightsail/src/commands/CreateBucketCommand.ts
@@ -30,7 +30,6 @@ export interface CreateBucketCommandOutput extends CreateBucketResult, __Metadat
 
 /**
  * <p>Creates an Amazon Lightsail bucket.</p>
- *
  *          <p>A bucket is a cloud storage resource available in the Lightsail object storage service.
  *       Use buckets to store objects such as data and its descriptive metadata. 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

diff --git a/clients/client-lightsail/src/commands/CreateContainerServiceCommand.ts b/clients/client-lightsail/src/commands/CreateContainerServiceCommand.ts
@@ -30,7 +30,6 @@ export interface CreateContainerServiceCommandOutput extends CreateContainerServ
 
 /**
  * <p>Creates an Amazon Lightsail container service.</p>
- *
  *          <p>A Lightsail container service is a compute resource to which you can deploy containers.
  *       For more information, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-services">Container services in Amazon Lightsail</a> in the <i>Lightsail Dev
  *         Guide</i>.</p>

diff --git a/clients/client-lightsail/src/commands/CreateContainerServiceDeploymentCommand.ts b/clients/client-lightsail/src/commands/CreateContainerServiceDeploymentCommand.ts
@@ -32,13 +32,11 @@ export interface CreateContainerServiceDeploymentCommandOutput
 
 /**
  * <p>Creates a deployment for your Amazon Lightsail container service.</p>
- *
  *          <p>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.</p>
- *
  *          <p>You can deploy containers to your container service using container images from a public
  *       registry such as Amazon ECR Public, or from your local machine. For more information, see
  *         <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

diff --git a/clients/client-lightsail/src/commands/CreateContainerServiceRegistryLoginCommand.ts b/clients/client-lightsail/src/commands/CreateContainerServiceRegistryLoginCommand.ts
@@ -37,17 +37,14 @@ export interface CreateContainerServiceRegistryLoginCommandOutput
  *       account so that you can use them with your Lightsail container service. The log in
  *       credentials expire 12 hours after they are created, at which point you will need to create a
  *       new set of log in credentials.</p>
- *
  *          <note>
  *             <p>You can only push container images to the container service registry of your Lightsail
  *         account. You cannot pull container images or perform any other container image management
  *         actions on the container service registry.</p>
  *          </note>
- *
  *          <p>After you push your container images to the container image registry of your Lightsail
  *       account, use the <code>RegisterContainerImage</code> action to register the pushed images to a
  *       specific Lightsail container service.</p>
- *
  *          <note>
  *             <p>This action is not required if you install and use the Lightsail Control
  *         (lightsailctl) plugin to push container images to your Lightsail container service. For

diff --git a/clients/client-lightsail/src/commands/CreateDiskSnapshotCommand.ts b/clients/client-lightsail/src/commands/CreateDiskSnapshotCommand.ts
@@ -46,7 +46,6 @@ export interface CreateDiskSnapshotCommandOutput extends CreateDiskSnapshotResul
  *       when issuing the snapshot command, and a snapshot of the defined instance's system volume will
  *       be created. After the snapshot is available, you can create a block storage disk from the
  *       snapshot and attach it to a running instance to access the data on the disk.</p>
- *
  *          <p>The <code>create disk snapshot</code> operation supports tag-based access control via
  *       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>
  * @example

diff --git a/clients/client-lightsail/src/commands/CreateDomainEntryCommand.ts b/clients/client-lightsail/src/commands/CreateDomainEntryCommand.ts
@@ -32,9 +32,6 @@ export interface CreateDomainEntryCommandOutput extends CreateDomainEntryResult,
  * <p>Creates one of the following domain name system (DNS) records in a domain DNS zone:
  *       Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority
  *       (SOA), service locator (SRV), or text (TXT).</p>
- *
- *
- *
  *          <p>The <code>create domain entry</code> operation supports tag-based access control via
  *       resource tags applied to the resource identified by <code>domain name</code>. 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>

diff --git a/clients/client-lightsail/src/commands/DeleteBucketAccessKeyCommand.ts b/clients/client-lightsail/src/commands/DeleteBucketAccessKeyCommand.ts
@@ -30,9 +30,7 @@ export interface DeleteBucketAccessKeyCommandOutput extends DeleteBucketAccessKe
 
 /**
  * <p>Deletes an access key for the specified Amazon Lightsail bucket.</p>
- *
  *          <p>We recommend that you delete an access key if the secret access key is compromised.</p>
- *
  *          <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
  *         <i>Amazon Lightsail Developer Guide</i>.</p>
  * @example

diff --git a/clients/client-lightsail/src/commands/DeleteBucketCommand.ts b/clients/client-lightsail/src/commands/DeleteBucketCommand.ts
@@ -30,7 +30,6 @@ export interface DeleteBucketCommandOutput extends DeleteBucketResult, __Metadat
 
 /**
  * <p>Deletes a Amazon Lightsail bucket.</p>
- *
  *          <note>
  *             <p>When you delete your bucket, the bucket name is released and can be reused for a new
  *         bucket in your account or another Amazon Web Services account.</p>

diff --git a/clients/client-lightsail/src/commands/DeleteKeyPairCommand.ts b/clients/client-lightsail/src/commands/DeleteKeyPairCommand.ts
@@ -34,7 +34,6 @@ export interface DeleteKeyPairCommandOutput extends DeleteKeyPairResult, __Metad
  *         <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
  *       key pair will not be created unless you launch an instance without specifying a custom key
  *       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>
- *
  *          <p>The <code>delete key pair</code> operation supports tag-based access control via resource
  *       tags applied to the resource identified by <code>key pair name</code>. 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>

diff --git a/clients/client-lightsail/src/commands/GetBucketAccessKeysCommand.ts b/clients/client-lightsail/src/commands/GetBucketAccessKeysCommand.ts
@@ -30,7 +30,6 @@ export interface GetBucketAccessKeysCommandOutput extends GetBucketAccessKeysRes
 
 /**
  * <p>Returns the existing access key IDs for the specified Amazon Lightsail bucket.</p>
- *
  *          <important>
  *             <p>This action does not return the secret access key value of an access key. You can get a
  *         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

diff --git a/clients/client-lightsail/src/commands/GetBucketBundlesCommand.ts b/clients/client-lightsail/src/commands/GetBucketBundlesCommand.ts
@@ -30,10 +30,8 @@ export interface GetBucketBundlesCommandOutput extends GetBucketBundlesResult, _
 
 /**
  * <p>Returns the bundles that you can apply to a Amazon Lightsail bucket.</p>
- *
  *          <p>The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a
  *       bucket.</p>
- *
  *          <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
  *       bundle for a bucket.</p>
  * @example

diff --git a/clients/client-lightsail/src/commands/GetBucketMetricDataCommand.ts b/clients/client-lightsail/src/commands/GetBucketMetricDataCommand.ts
@@ -30,7 +30,6 @@ export interface GetBucketMetricDataCommandOutput extends GetBucketMetricDataRes
 
 /**
  * <p>Returns the data points of a specific metric for an Amazon Lightsail bucket.</p>
- *
  *          <p>Metrics report the utilization of a bucket. View and collect metric data regularly to
  *       monitor the number of objects stored in a bucket (including object versions) and the storage
  *       space used by those objects.</p>

diff --git a/clients/client-lightsail/src/commands/GetBucketsCommand.ts b/clients/client-lightsail/src/commands/GetBucketsCommand.ts
@@ -32,7 +32,6 @@ export interface GetBucketsCommandOutput extends GetBucketsResult, __MetadataBea
  * <p>Returns information about one or more Amazon Lightsail buckets. The information returned
  *       includes the synchronization status of the Amazon Simple Storage Service (Amazon S3)
  *       account-level block public access feature for your Lightsail buckets.</p>
- *
  *          <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
  *         Guide</i>.</p>
  * @example

diff --git a/clients/client-lightsail/src/commands/GetBundlesCommand.ts b/clients/client-lightsail/src/commands/GetBundlesCommand.ts
@@ -31,11 +31,9 @@ export interface GetBundlesCommandOutput extends GetBundlesResult, __MetadataBea
 /**
  * <p>Returns the bundles that you can apply to an Amazon Lightsail instance when you create
  *       it.</p>
- *
  *          <p>A bundle describes the specifications of an instance, such as the monthly cost, amount of
  *       memory, the number of vCPUs, amount of storage space, and monthly network data transfer
  *       quota.</p>
- *
  *          <note>
  *             <p>Bundles are referred to as <i>instance plans</i> in the Lightsail
  *         console.</p>

diff --git a/clients/client-lightsail/src/commands/GetContainerImagesCommand.ts b/clients/client-lightsail/src/commands/GetContainerImagesCommand.ts
@@ -31,7 +31,6 @@ export interface GetContainerImagesCommandOutput extends GetContainerImagesResul
 /**
  * <p>Returns the container images that are registered to your Amazon Lightsail container
  *       service.</p>
- *
  *          <note>
  *             <p>If you created a deployment on your Lightsail container service that uses container
  *         images from a public registry like Docker Hub, those images are not returned as part of this

diff --git a/clients/client-lightsail/src/commands/GetContainerLogCommand.ts b/clients/client-lightsail/src/commands/GetContainerLogCommand.ts
@@ -30,11 +30,9 @@ export interface GetContainerLogCommandOutput extends GetContainerLogResult, __M
 
 /**
  * <p>Returns the log events of a container of your Amazon Lightsail container service.</p>
- *
  *          <p>If your container service has more than one node (i.e., a scale greater than 1), then the
  *       log events that are returned for the specified container are merged from all nodes on your
  *       container service.</p>
- *
  *          <note>
  *             <p>Container logs are retained for a certain amount of time. For more information, see
  *           <a href="https://docs.aws.amazon.com/general/latest/gr/lightsail.html">Amazon Lightsail

diff --git a/clients/client-lightsail/src/commands/GetContainerServiceDeploymentsCommand.ts b/clients/client-lightsail/src/commands/GetContainerServiceDeploymentsCommand.ts
@@ -32,13 +32,10 @@ export interface GetContainerServiceDeploymentsCommandOutput
 
 /**
  * <p>Returns the deployments for your Amazon Lightsail container service</p>
- *
  *          <p>A deployment specifies the settings, such as the ports and launch command, of containers
  *       that are deployed to your container service.</p>
- *
  *          <p>The deployments are ordered by version in ascending order. The newest version is listed at
  *       the top of the response.</p>
- *
  *          <note>
  *             <p>A set number of deployments are kept before the oldest one is replaced with the newest
  *         one. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/lightsail.html">Amazon Lightsail

diff --git a/clients/client-lightsail/src/commands/GetContainerServiceMetricDataCommand.ts b/clients/client-lightsail/src/commands/GetContainerServiceMetricDataCommand.ts
@@ -33,7 +33,6 @@ export interface GetContainerServiceMetricDataCommandOutput
 /**
  * <p>Returns the data points of a specific metric of your Amazon Lightsail container
  *       service.</p>
- *
  *          <p>Metrics report the utilization of your resources. Monitor and collect metric data
  *       regularly to maintain the reliability, availability, and performance of your resources.</p>
  * @example

diff --git a/clients/client-lightsail/src/commands/GetContainerServicePowersCommand.ts b/clients/client-lightsail/src/commands/GetContainerServicePowersCommand.ts
@@ -31,7 +31,6 @@ export interface GetContainerServicePowersCommandOutput extends GetContainerServ
 /**
  * <p>Returns the list of powers that can be specified for your Amazon Lightsail container
  *       services.</p>
- *
  *          <p>The power specifies the amount of memory, the number of vCPUs, and the base price of the
  *       container service.</p>
  * @example

diff --git a/clients/client-lightsail/src/commands/GetLoadBalancerTlsPoliciesCommand.ts b/clients/client-lightsail/src/commands/GetLoadBalancerTlsPoliciesCommand.ts
@@ -31,7 +31,6 @@ export interface GetLoadBalancerTlsPoliciesCommandOutput extends GetLoadBalancer
 /**
  * <p>Returns a list of TLS security policies that you can apply to Lightsail load
  *       balancers.</p>
- *
  *          <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
  *         balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>
  * @example

diff --git a/clients/client-lightsail/src/commands/RegisterContainerImageCommand.ts b/clients/client-lightsail/src/commands/RegisterContainerImageCommand.ts
@@ -30,7 +30,6 @@ export interface RegisterContainerImageCommandOutput extends RegisterContainerIm
 
 /**
  * <p>Registers a container image to your Amazon Lightsail container service.</p>
- *
  *          <note>
  *             <p>This action is not required if you install and use the Lightsail Control
  *         (lightsailctl) plugin to push container images to your Lightsail container service. For

diff --git a/clients/client-lightsail/src/commands/SetIpAddressTypeCommand.ts b/clients/client-lightsail/src/commands/SetIpAddressTypeCommand.ts
@@ -30,7 +30,6 @@ export interface SetIpAddressTypeCommandOutput extends SetIpAddressTypeResult, _
 
 /**
  * <p>Sets the IP address type for an Amazon Lightsail resource.</p>
- *
  *          <p>Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the
  *       specified resource. Alternately, you can use this action to disable dual-stack, and enable
  *       IPv4 only.</p>

diff --git a/clients/client-lightsail/src/commands/SetResourceAccessForBucketCommand.ts b/clients/client-lightsail/src/commands/SetResourceAccessForBucketCommand.ts
@@ -31,7 +31,6 @@ export interface SetResourceAccessForBucketCommandOutput extends SetResourceAcce
 /**
  * <p>Sets the Amazon Lightsail resources that can access the specified Lightsail
  *       bucket.</p>
- *
  *          <p>Lightsail buckets currently support setting access for Lightsail instances in the same
  *         Amazon Web Services Region.</p>
  * @example

diff --git a/clients/client-lightsail/src/commands/UpdateBucketBundleCommand.ts b/clients/client-lightsail/src/commands/UpdateBucketBundleCommand.ts
@@ -30,13 +30,11 @@ export interface UpdateBucketBundleCommandOutput extends UpdateBucketBundleResul
 
 /**
  * <p>Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.</p>
- *
  *          <p>A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a
  *       bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services
  *       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
  *         <code>ableToUpdateBundle</code> parameter in the response will indicate whether you can
  *       currently update a bucket's bundle.</p>
- *
  *          <p>Update a bucket's bundle if it's consistently going over its storage space or data
  *       transfer quota, or if a bucket's usage is consistently in the lower range of its storage space
  *       or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might

diff --git a/clients/client-lightsail/src/commands/UpdateBucketCommand.ts b/clients/client-lightsail/src/commands/UpdateBucketCommand.ts
@@ -30,7 +30,6 @@ export interface UpdateBucketCommandOutput extends UpdateBucketResult, __Metadat
 
 /**
  * <p>Updates an existing Amazon Lightsail bucket.</p>
- *
  *          <p>Use this action to update the configuration of an existing bucket, such as versioning,
  *       public accessibility, and the Amazon Web Services accounts that can access the bucket.</p>
  * @example

diff --git a/clients/client-lightsail/src/endpoint/EndpointParameters.ts b/clients/client-lightsail/src/endpoint/EndpointParameters.ts
@@ -24,7 +24,7 @@ export const resolveClientEndpointParameters = <T>(
 };
 
 export interface EndpointParameters extends __EndpointParameters {
-  Region?: string;
+  Region: string;
   UseDualStack?: boolean;
   UseFIPS?: boolean;
   Endpoint?: string;