@aws-sdk/client-lightsail 3.296.0 → 3.297.0

package/dist-types/commands/UpdateBucketCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient";
 import { UpdateBucketRequest, UpdateBucketResult } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateBucketCommand}.
  */
 export interface UpdateBucketCommandInput extends UpdateBucketRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateBucketCommand}.
  */
 export interface UpdateBucketCommandOutput extends UpdateBucketResult, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
@@ -27,6 +32,8 @@ export interface UpdateBucketCommandOutput extends UpdateBucketResult, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateBucketCommandInput - {@link UpdateBucketCommandInput}
+ * @returns {@link UpdateBucketCommandOutput}
  * @see {@link UpdateBucketCommandInput} for command's `input` shape.
  * @see {@link UpdateBucketCommandOutput} for command's `response` shape.
  * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape.
@@ -59,11 +66,20 @@ export interface UpdateBucketCommandOutput extends UpdateBucketResult, __Metadat
 export declare class UpdateBucketCommand extends $Command<UpdateBucketCommandInput, UpdateBucketCommandOutput, LightsailClientResolvedConfig> {
     readonly input: UpdateBucketCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateBucketCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LightsailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateBucketCommandInput, UpdateBucketCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateContainerServiceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient";
 import { UpdateContainerServiceRequest, UpdateContainerServiceResult } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateContainerServiceCommand}.
  */
 export interface UpdateContainerServiceCommandInput extends UpdateContainerServiceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateContainerServiceCommand}.
  */
 export interface UpdateContainerServiceCommandOutput extends UpdateContainerServiceResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the configuration of your Amazon Lightsail container service, such as its power,
  *       scale, and public domain names.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateContainerServiceCommandOutput extends UpdateContainerServ
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateContainerServiceCommandInput - {@link UpdateContainerServiceCommandInput}
+ * @returns {@link UpdateContainerServiceCommandOutput}
  * @see {@link UpdateContainerServiceCommandInput} for command's `input` shape.
  * @see {@link UpdateContainerServiceCommandOutput} for command's `response` shape.
  * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape.
@@ -58,11 +65,20 @@ export interface UpdateContainerServiceCommandOutput extends UpdateContainerServ
 export declare class UpdateContainerServiceCommand extends $Command<UpdateContainerServiceCommandInput, UpdateContainerServiceCommandOutput, LightsailClientResolvedConfig> {
     readonly input: UpdateContainerServiceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateContainerServiceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LightsailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateContainerServiceCommandInput, UpdateContainerServiceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateDistributionBundleCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient";
 import { UpdateDistributionBundleRequest, UpdateDistributionBundleResult } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateDistributionBundleCommand}.
  */
 export interface UpdateDistributionBundleCommandInput extends UpdateDistributionBundleRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateDistributionBundleCommand}.
  */
 export interface UpdateDistributionBundleCommandOutput extends UpdateDistributionBundleResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the bundle of your Amazon Lightsail content delivery network (CDN)
  *       distribution.</p>
  *          <p>A distribution bundle specifies the monthly network transfer quota and monthly cost of
@@ -33,6 +38,8 @@ export interface UpdateDistributionBundleCommandOutput extends UpdateDistributio
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateDistributionBundleCommandInput - {@link UpdateDistributionBundleCommandInput}
+ * @returns {@link UpdateDistributionBundleCommandOutput}
  * @see {@link UpdateDistributionBundleCommandInput} for command's `input` shape.
  * @see {@link UpdateDistributionBundleCommandOutput} for command's `response` shape.
  * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape.
@@ -68,11 +75,20 @@ export interface UpdateDistributionBundleCommandOutput extends UpdateDistributio
 export declare class UpdateDistributionBundleCommand extends $Command<UpdateDistributionBundleCommandInput, UpdateDistributionBundleCommandOutput, LightsailClientResolvedConfig> {
     readonly input: UpdateDistributionBundleCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateDistributionBundleCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LightsailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDistributionBundleCommandInput, UpdateDistributionBundleCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateDistributionCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient";
 import { UpdateDistributionRequest, UpdateDistributionResult } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateDistributionCommand}.
  */
 export interface UpdateDistributionCommandInput extends UpdateDistributionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateDistributionCommand}.
  */
 export interface UpdateDistributionCommandOutput extends UpdateDistributionResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates an existing Amazon Lightsail content delivery network (CDN) distribution.</p>
  *          <p>Use this action to update the configuration of your existing distribution.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateDistributionCommandOutput extends UpdateDistributionResul
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateDistributionCommandInput - {@link UpdateDistributionCommandInput}
+ * @returns {@link UpdateDistributionCommandOutput}
  * @see {@link UpdateDistributionCommandInput} for command's `input` shape.
  * @see {@link UpdateDistributionCommandOutput} for command's `response` shape.
  * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape.
@@ -61,11 +68,20 @@ export interface UpdateDistributionCommandOutput extends UpdateDistributionResul
 export declare class UpdateDistributionCommand extends $Command<UpdateDistributionCommandInput, UpdateDistributionCommandOutput, LightsailClientResolvedConfig> {
     readonly input: UpdateDistributionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateDistributionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LightsailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDistributionCommandInput, UpdateDistributionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateDomainEntryCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient";
 import { UpdateDomainEntryRequest, UpdateDomainEntryResult } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateDomainEntryCommand}.
  */
 export interface UpdateDomainEntryCommandInput extends UpdateDomainEntryRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateDomainEntryCommand}.
  */
 export interface UpdateDomainEntryCommandOutput extends UpdateDomainEntryResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates a domain recordset after it is created.</p>
  *          <p>The <code>update domain entry</code> operation supports tag-based access control via
  *       resource tags applied to the resource identified by <code>domain name</code>. For more
@@ -28,6 +33,8 @@ export interface UpdateDomainEntryCommandOutput extends UpdateDomainEntryResult,
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateDomainEntryCommandInput - {@link UpdateDomainEntryCommandInput}
+ * @returns {@link UpdateDomainEntryCommandOutput}
  * @see {@link UpdateDomainEntryCommandInput} for command's `input` shape.
  * @see {@link UpdateDomainEntryCommandOutput} for command's `response` shape.
  * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape.
@@ -67,11 +74,20 @@ export interface UpdateDomainEntryCommandOutput extends UpdateDomainEntryResult,
 export declare class UpdateDomainEntryCommand extends $Command<UpdateDomainEntryCommandInput, UpdateDomainEntryCommandOutput, LightsailClientResolvedConfig> {
     readonly input: UpdateDomainEntryCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateDomainEntryCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LightsailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDomainEntryCommandInput, UpdateDomainEntryCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateInstanceMetadataOptionsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient";
 import { UpdateInstanceMetadataOptionsRequest, UpdateInstanceMetadataOptionsResult } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateInstanceMetadataOptionsCommand}.
  */
 export interface UpdateInstanceMetadataOptionsCommandInput extends UpdateInstanceMetadataOptionsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateInstanceMetadataOptionsCommand}.
  */
 export interface UpdateInstanceMetadataOptionsCommandOutput extends UpdateInstanceMetadataOptionsResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Modifies the Amazon Lightsail instance metadata parameters on a running or stopped
  *       instance. When you modify the parameters on a running instance, the <code>GetInstance</code>
  *       or <code>GetInstances</code> API operation initially responds with a state of
@@ -30,6 +35,8 @@ export interface UpdateInstanceMetadataOptionsCommandOutput extends UpdateInstan
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateInstanceMetadataOptionsCommandInput - {@link UpdateInstanceMetadataOptionsCommandInput}
+ * @returns {@link UpdateInstanceMetadataOptionsCommandOutput}
  * @see {@link UpdateInstanceMetadataOptionsCommandInput} for command's `input` shape.
  * @see {@link UpdateInstanceMetadataOptionsCommandOutput} for command's `response` shape.
  * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape.
@@ -69,11 +76,20 @@ export interface UpdateInstanceMetadataOptionsCommandOutput extends UpdateInstan
 export declare class UpdateInstanceMetadataOptionsCommand extends $Command<UpdateInstanceMetadataOptionsCommandInput, UpdateInstanceMetadataOptionsCommandOutput, LightsailClientResolvedConfig> {
     readonly input: UpdateInstanceMetadataOptionsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateInstanceMetadataOptionsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LightsailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateInstanceMetadataOptionsCommandInput, UpdateInstanceMetadataOptionsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateLoadBalancerAttributeCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient";
 import { UpdateLoadBalancerAttributeRequest, UpdateLoadBalancerAttributeResult } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateLoadBalancerAttributeCommand}.
  */
 export interface UpdateLoadBalancerAttributeCommandInput extends UpdateLoadBalancerAttributeRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateLoadBalancerAttributeCommand}.
  */
 export interface UpdateLoadBalancerAttributeCommandOutput extends UpdateLoadBalancerAttributeResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the specified attribute for a load balancer. You can only update one attribute at
  *       a time.</p>
  *          <p>The <code>update load balancer attribute</code> operation supports tag-based access
@@ -29,6 +34,8 @@ export interface UpdateLoadBalancerAttributeCommandOutput extends UpdateLoadBala
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateLoadBalancerAttributeCommandInput - {@link UpdateLoadBalancerAttributeCommandInput}
+ * @returns {@link UpdateLoadBalancerAttributeCommandOutput}
  * @see {@link UpdateLoadBalancerAttributeCommandInput} for command's `input` shape.
  * @see {@link UpdateLoadBalancerAttributeCommandOutput} for command's `response` shape.
  * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape.
@@ -68,11 +75,20 @@ export interface UpdateLoadBalancerAttributeCommandOutput extends UpdateLoadBala
 export declare class UpdateLoadBalancerAttributeCommand extends $Command<UpdateLoadBalancerAttributeCommandInput, UpdateLoadBalancerAttributeCommandOutput, LightsailClientResolvedConfig> {
     readonly input: UpdateLoadBalancerAttributeCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateLoadBalancerAttributeCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LightsailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateLoadBalancerAttributeCommandInput, UpdateLoadBalancerAttributeCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateRelationalDatabaseCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient";
 import { UpdateRelationalDatabaseRequest, UpdateRelationalDatabaseResult } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateRelationalDatabaseCommand}.
  */
 export interface UpdateRelationalDatabaseCommandInput extends UpdateRelationalDatabaseRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateRelationalDatabaseCommand}.
  */
 export interface UpdateRelationalDatabaseCommandOutput extends UpdateRelationalDatabaseResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Allows the update of one or more attributes of a database in Amazon Lightsail.</p>
  *          <p>Updates are applied immediately, or in cases where the updates could result in an outage,
  *       are applied during the database's predefined maintenance window.</p>
@@ -30,6 +35,8 @@ export interface UpdateRelationalDatabaseCommandOutput extends UpdateRelationalD
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateRelationalDatabaseCommandInput - {@link UpdateRelationalDatabaseCommandInput}
+ * @returns {@link UpdateRelationalDatabaseCommandOutput}
  * @see {@link UpdateRelationalDatabaseCommandInput} for command's `input` shape.
  * @see {@link UpdateRelationalDatabaseCommandOutput} for command's `response` shape.
  * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape.
@@ -69,11 +76,20 @@ export interface UpdateRelationalDatabaseCommandOutput extends UpdateRelationalD
 export declare class UpdateRelationalDatabaseCommand extends $Command<UpdateRelationalDatabaseCommandInput, UpdateRelationalDatabaseCommandOutput, LightsailClientResolvedConfig> {
     readonly input: UpdateRelationalDatabaseCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateRelationalDatabaseCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LightsailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateRelationalDatabaseCommandInput, UpdateRelationalDatabaseCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateRelationalDatabaseParametersCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient";
 import { UpdateRelationalDatabaseParametersRequest, UpdateRelationalDatabaseParametersResult } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateRelationalDatabaseParametersCommand}.
  */
 export interface UpdateRelationalDatabaseParametersCommandInput extends UpdateRelationalDatabaseParametersRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateRelationalDatabaseParametersCommand}.
  */
 export interface UpdateRelationalDatabaseParametersCommandOutput extends UpdateRelationalDatabaseParametersResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Allows the update of one or more parameters of a database in Amazon Lightsail.</p>
  *          <p>Parameter updates don't cause outages; therefore, their application is not subject to the
  *       preferred maintenance window. However, there are two ways in which parameter updates are
@@ -34,6 +39,8 @@ export interface UpdateRelationalDatabaseParametersCommandOutput extends UpdateR
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateRelationalDatabaseParametersCommandInput - {@link UpdateRelationalDatabaseParametersCommandInput}
+ * @returns {@link UpdateRelationalDatabaseParametersCommandOutput}
  * @see {@link UpdateRelationalDatabaseParametersCommandInput} for command's `input` shape.
  * @see {@link UpdateRelationalDatabaseParametersCommandOutput} for command's `response` shape.
  * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape.
@@ -73,11 +80,20 @@ export interface UpdateRelationalDatabaseParametersCommandOutput extends UpdateR
 export declare class UpdateRelationalDatabaseParametersCommand extends $Command<UpdateRelationalDatabaseParametersCommandInput, UpdateRelationalDatabaseParametersCommandOutput, LightsailClientResolvedConfig> {
     readonly input: UpdateRelationalDatabaseParametersCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateRelationalDatabaseParametersCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LightsailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateRelationalDatabaseParametersCommandInput, UpdateRelationalDatabaseParametersCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/LightsailServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from Lightsail service.
  */
 export declare class LightsailServiceException extends __ServiceException {