@aws-sdk/client-backup 3.296.0 → 3.298.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
 import { TagResourceInput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceInput {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault
  *          identified by an Amazon Resource Name (ARN).</p>
  * @example
@@ -26,6 +31,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
@@ -52,11 +59,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, BackupClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
 import { UntagResourceInput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes a set of key-value pairs from a recovery point, backup plan, or backup vault
  *          identified by an Amazon Resource Name (ARN)</p>
  * @example
@@ -26,6 +31,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
@@ -48,11 +55,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, BackupClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
 import { UpdateBackupPlanInput, UpdateBackupPlanOutput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateBackupPlanCommand}.
  */
 export interface UpdateBackupPlanCommandInput extends UpdateBackupPlanInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateBackupPlanCommand}.
  */
 export interface UpdateBackupPlanCommandOutput extends UpdateBackupPlanOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates an existing backup plan identified by its <code>backupPlanId</code> with the
  *          input document in JSON format. The new version is uniquely identified by a
  *             <code>VersionId</code>.</p>
@@ -27,6 +32,8 @@ export interface UpdateBackupPlanCommandOutput extends UpdateBackupPlanOutput, _
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateBackupPlanCommandInput - {@link UpdateBackupPlanCommandInput}
+ * @returns {@link UpdateBackupPlanCommandOutput}
  * @see {@link UpdateBackupPlanCommandInput} for command's `input` shape.
  * @see {@link UpdateBackupPlanCommandOutput} for command's `response` shape.
  * @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UpdateBackupPlanCommandOutput extends UpdateBackupPlanOutput, _
 export declare class UpdateBackupPlanCommand extends $Command<UpdateBackupPlanCommandInput, UpdateBackupPlanCommandOutput, BackupClientResolvedConfig> {
     readonly input: UpdateBackupPlanCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateBackupPlanCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateBackupPlanCommandInput, UpdateBackupPlanCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
 import { UpdateFrameworkInput, UpdateFrameworkOutput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateFrameworkCommand}.
  */
 export interface UpdateFrameworkCommandInput extends UpdateFrameworkInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateFrameworkCommand}.
  */
 export interface UpdateFrameworkCommandOutput extends UpdateFrameworkOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates an existing framework identified by its <code>FrameworkName</code> with the
  *          input document in JSON format.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateFrameworkCommandOutput extends UpdateFrameworkOutput, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateFrameworkCommandInput - {@link UpdateFrameworkCommandInput}
+ * @returns {@link UpdateFrameworkCommandOutput}
  * @see {@link UpdateFrameworkCommandInput} for command's `input` shape.
  * @see {@link UpdateFrameworkCommandOutput} for command's `response` shape.
  * @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
@@ -59,11 +66,20 @@ export interface UpdateFrameworkCommandOutput extends UpdateFrameworkOutput, __M
 export declare class UpdateFrameworkCommand extends $Command<UpdateFrameworkCommandInput, UpdateFrameworkCommandOutput, BackupClientResolvedConfig> {
     readonly input: UpdateFrameworkCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateFrameworkCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateFrameworkCommandInput, UpdateFrameworkCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
 import { UpdateGlobalSettingsInput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateGlobalSettingsCommand}.
  */
 export interface UpdateGlobalSettingsCommandInput extends UpdateGlobalSettingsInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateGlobalSettingsCommand}.
  */
 export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates whether the Amazon Web Services account is opted in to cross-account backup.
  *          Returns an error if the account is not an Organizations management account. Use the
  *             <code>DescribeGlobalSettings</code> API to determine the current settings.</p>
@@ -27,6 +32,8 @@ export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateGlobalSettingsCommandInput - {@link UpdateGlobalSettingsCommandInput}
+ * @returns {@link UpdateGlobalSettingsCommandOutput}
  * @see {@link UpdateGlobalSettingsCommandInput} for command's `input` shape.
  * @see {@link UpdateGlobalSettingsCommandOutput} for command's `response` shape.
  * @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
@@ -50,11 +57,20 @@ export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {
 export declare class UpdateGlobalSettingsCommand extends $Command<UpdateGlobalSettingsCommandInput, UpdateGlobalSettingsCommandOutput, BackupClientResolvedConfig> {
     readonly input: UpdateGlobalSettingsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateGlobalSettingsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateGlobalSettingsCommandInput, UpdateGlobalSettingsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
 import { UpdateRecoveryPointLifecycleInput, UpdateRecoveryPointLifecycleOutput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateRecoveryPointLifecycleCommand}.
  */
 export interface UpdateRecoveryPointLifecycleCommandInput extends UpdateRecoveryPointLifecycleInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateRecoveryPointLifecycleCommand}.
  */
 export interface UpdateRecoveryPointLifecycleCommandOutput extends UpdateRecoveryPointLifecycleOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Sets the transition lifecycle of a recovery point.</p>
  *          <p>The lifecycle defines when a protected resource is transitioned to cold storage and when
  *          it expires. Backup transitions and expires backups automatically according to
@@ -37,6 +42,8 @@ export interface UpdateRecoveryPointLifecycleCommandOutput extends UpdateRecover
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateRecoveryPointLifecycleCommandInput - {@link UpdateRecoveryPointLifecycleCommandInput}
+ * @returns {@link UpdateRecoveryPointLifecycleCommandOutput}
  * @see {@link UpdateRecoveryPointLifecycleCommandInput} for command's `input` shape.
  * @see {@link UpdateRecoveryPointLifecycleCommandOutput} for command's `response` shape.
  * @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
@@ -63,11 +70,20 @@ export interface UpdateRecoveryPointLifecycleCommandOutput extends UpdateRecover
 export declare class UpdateRecoveryPointLifecycleCommand extends $Command<UpdateRecoveryPointLifecycleCommandInput, UpdateRecoveryPointLifecycleCommandOutput, BackupClientResolvedConfig> {
     readonly input: UpdateRecoveryPointLifecycleCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateRecoveryPointLifecycleCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateRecoveryPointLifecycleCommandInput, UpdateRecoveryPointLifecycleCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
 import { UpdateRegionSettingsInput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateRegionSettingsCommand}.
  */
 export interface UpdateRegionSettingsCommandInput extends UpdateRegionSettingsInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateRegionSettingsCommand}.
  */
 export interface UpdateRegionSettingsCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the current service opt-in settings for the Region. If service-opt-in is enabled
  *          for a service, Backup tries to protect that service's resources in this Region,
  *          when the resource is included in an on-demand backup or scheduled backup plan. Otherwise,
@@ -30,6 +35,8 @@ export interface UpdateRegionSettingsCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateRegionSettingsCommandInput - {@link UpdateRegionSettingsCommandInput}
+ * @returns {@link UpdateRegionSettingsCommandOutput}
  * @see {@link UpdateRegionSettingsCommandInput} for command's `input` shape.
  * @see {@link UpdateRegionSettingsCommandOutput} for command's `response` shape.
  * @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UpdateRegionSettingsCommandOutput extends __MetadataBearer {
 export declare class UpdateRegionSettingsCommand extends $Command<UpdateRegionSettingsCommandInput, UpdateRegionSettingsCommandOutput, BackupClientResolvedConfig> {
     readonly input: UpdateRegionSettingsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateRegionSettingsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateRegionSettingsCommandInput, UpdateRegionSettingsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
 import { UpdateReportPlanInput, UpdateReportPlanOutput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateReportPlanCommand}.
  */
 export interface UpdateReportPlanCommandInput extends UpdateReportPlanInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateReportPlanCommand}.
  */
 export interface UpdateReportPlanCommandOutput extends UpdateReportPlanOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates an existing report plan identified by its <code>ReportPlanName</code> with the
  *          input document in JSON format.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateReportPlanCommandOutput extends UpdateReportPlanOutput, _
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateReportPlanCommandInput - {@link UpdateReportPlanCommandInput}
+ * @returns {@link UpdateReportPlanCommandOutput}
  * @see {@link UpdateReportPlanCommandInput} for command's `input` shape.
  * @see {@link UpdateReportPlanCommandOutput} for command's `response` shape.
  * @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UpdateReportPlanCommandOutput extends UpdateReportPlanOutput, _
 export declare class UpdateReportPlanCommand extends $Command<UpdateReportPlanCommandInput, UpdateReportPlanCommandOutput, BackupClientResolvedConfig> {
     readonly input: UpdateReportPlanCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateReportPlanCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateReportPlanCommandInput, UpdateReportPlanCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/BackupServiceException.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 Backup service.
  */
 export declare class BackupServiceException extends __ServiceException {