@aws-sdk/client-backup 3.635.0 → 3.643.0

package/dist-cjs/index.js

@@ -438,6 +438,15 @@ var BackupVaultEvent = {
   S3_BACKUP_OBJECT_FAILED: "S3_BACKUP_OBJECT_FAILED",
   S3_RESTORE_OBJECT_FAILED: "S3_RESTORE_OBJECT_FAILED"
 };
+var VaultState = {
+  AVAILABLE: "AVAILABLE",
+  CREATING: "CREATING",
+  FAILED: "FAILED"
+};
+var VaultType = {
+  BACKUP_VAULT: "BACKUP_VAULT",
+  LOGICALLY_AIR_GAPPED_BACKUP_VAULT: "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
+};
 var _InvalidParameterValueException = class _InvalidParameterValueException extends BackupServiceException {
   /**
    * @internal
@@ -611,11 +620,6 @@ var LegalHoldStatus = {
   CANCELING: "CANCELING",
   CREATING: "CREATING"
 };
-var VaultState = {
-  AVAILABLE: "AVAILABLE",
-  CREATING: "CREATING",
-  FAILED: "FAILED"
-};
 var _InvalidRequestException = class _InvalidRequestException extends BackupServiceException {
   /**
    * @internal
@@ -666,10 +670,6 @@ var _DependencyFailureException = class _DependencyFailureException extends Back
 };
 __name(_DependencyFailureException, "DependencyFailureException");
 var DependencyFailureException = _DependencyFailureException;
-var VaultType = {
-  BACKUP_VAULT: "BACKUP_VAULT",
-  LOGICALLY_AIR_GAPPED_BACKUP_VAULT: "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
-};
 var RecoveryPointStatus = {
   COMPLETED: "COMPLETED",
   DELETING: "DELETING",
@@ -2393,6 +2393,7 @@ var de_DescribeBackupVaultCommand = /* @__PURE__ */ __name(async (output, contex
     MaxRetentionDays: import_smithy_client.expectLong,
     MinRetentionDays: import_smithy_client.expectLong,
     NumberOfRecoveryPoints: import_smithy_client.expectLong,
+    VaultState: import_smithy_client.expectString,
     VaultType: import_smithy_client.expectString
   });
   Object.assign(contents, doc);
@@ -3777,7 +3778,9 @@ var de_BackupVaultListMember = /* @__PURE__ */ __name((output, context) => {
     Locked: import_smithy_client.expectBoolean,
     MaxRetentionDays: import_smithy_client.expectLong,
     MinRetentionDays: import_smithy_client.expectLong,
-    NumberOfRecoveryPoints: import_smithy_client.expectLong
+    NumberOfRecoveryPoints: import_smithy_client.expectLong,
+    VaultState: import_smithy_client.expectString,
+    VaultType: import_smithy_client.expectString
   });
 }, "de_BackupVaultListMember");
 var de_CalculatedLifecycle = /* @__PURE__ */ __name((output, context) => {
@@ -5951,6 +5954,8 @@ var paginateListTags = (0, import_core.createPaginator)(BackupClient, ListTagsCo
   BackupJobStatus,
   ConditionType,
   BackupVaultEvent,
+  VaultState,
+  VaultType,
   InvalidParameterValueException,
   InvalidResourceStateException,
   MissingParameterValueException,
@@ -5961,12 +5966,10 @@ var paginateListTags = (0, import_core.createPaginator)(BackupClient, ListTagsCo
   CopyJobStatus,
   LimitExceededException,
   LegalHoldStatus,
-  VaultState,
   InvalidRequestException,
   RestoreTestingRecoveryPointSelectionAlgorithm,
   RestoreTestingRecoveryPointType,
   DependencyFailureException,
-  VaultType,
   RecoveryPointStatus,
   StorageClass,
   RestoreDeletionStatus,

package/dist-es/models/models_0.js

@@ -69,6 +69,15 @@ export const BackupVaultEvent = {
     S3_BACKUP_OBJECT_FAILED: "S3_BACKUP_OBJECT_FAILED",
     S3_RESTORE_OBJECT_FAILED: "S3_RESTORE_OBJECT_FAILED",
 };
+export const VaultState = {
+    AVAILABLE: "AVAILABLE",
+    CREATING: "CREATING",
+    FAILED: "FAILED",
+};
+export const VaultType = {
+    BACKUP_VAULT: "BACKUP_VAULT",
+    LOGICALLY_AIR_GAPPED_BACKUP_VAULT: "LOGICALLY_AIR_GAPPED_BACKUP_VAULT",
+};
 export class InvalidParameterValueException extends __BaseException {
     constructor(opts) {
         super({
@@ -207,11 +216,6 @@ export const LegalHoldStatus = {
     CANCELING: "CANCELING",
     CREATING: "CREATING",
 };
-export const VaultState = {
-    AVAILABLE: "AVAILABLE",
-    CREATING: "CREATING",
-    FAILED: "FAILED",
-};
 export class InvalidRequestException extends __BaseException {
     constructor(opts) {
         super({
@@ -252,10 +256,6 @@ export class DependencyFailureException extends __BaseException {
         this.Context = opts.Context;
     }
 }
-export const VaultType = {
-    BACKUP_VAULT: "BACKUP_VAULT",
-    LOGICALLY_AIR_GAPPED_BACKUP_VAULT: "LOGICALLY_AIR_GAPPED_BACKUP_VAULT",
-};
 export const RecoveryPointStatus = {
     COMPLETED: "COMPLETED",
     DELETING: "DELETING",

package/dist-es/protocols/Aws_restJson1.js

@@ -1519,6 +1519,7 @@ export const de_DescribeBackupVaultCommand = async (output, context) => {
         MaxRetentionDays: __expectLong,
         MinRetentionDays: __expectLong,
         NumberOfRecoveryPoints: __expectLong,
+        VaultState: __expectString,
         VaultType: __expectString,
     });
     Object.assign(contents, doc);
@@ -2916,6 +2917,8 @@ const de_BackupVaultListMember = (output, context) => {
         MaxRetentionDays: __expectLong,
         MinRetentionDays: __expectLong,
         NumberOfRecoveryPoints: __expectLong,
+        VaultState: __expectString,
+        VaultType: __expectString,
     });
 };
 const de_CalculatedLifecycle = (output, context) => {

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

@@ -27,8 +27,8 @@ declare const CancelLegalHoldCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>This action removes the specified legal hold on a recovery point.
- *          This action can only be performed by a user with sufficient permissions.</p>
+ * <p>Removes the specified legal hold on a recovery point. This action can only be performed
+ *          by a user with sufficient permissions.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,10 +27,10 @@ declare const CreateLegalHoldCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>This action creates a legal hold on a recovery point (backup). A legal hold
- *          is a restraint on altering or deleting a backup until an authorized user cancels the
- *          legal hold. Any actions to delete or disassociate a recovery point will fail with
- *          an error if one or more active legal holds are on the recovery point.</p>
+ * <p>Creates a legal hold on a recovery point (backup). A legal hold is a restraint on
+ *          altering or deleting a backup until an authorized user cancels the legal hold. Any actions
+ *          to delete or disassociate a recovery point will fail with an error if one or more active
+ *          legal holds are on the recovery point.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const CreateLogicallyAirGappedBackupVaultCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>This request creates a logical container to where backups may be copied.</p>
+ * <p>Creates a logical container to where backups may be copied.</p>
  *          <p>This request includes a name, the Region, the maximum number of retention days, the
  *       minimum number of retention days, and optionally can include tags and a creator request
  *       ID.</p>

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

@@ -27,11 +27,10 @@ declare const CreateRestoreTestingPlanCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>This is the first of two steps to create a restore testing
- *          plan; once this request is successful, finish the procedure with
- *          request CreateRestoreTestingSelection.</p>
- *          <p>You must include the parameter RestoreTestingPlan. You may
- *          optionally include CreatorRequestId and Tags.</p>
+ * <p>Creates a restore testing plan.</p>
+ *          <p>The first of two steps to create a restore testing
+ *          plan. After this request is successful, finish the procedure using
+ *          CreateRestoreTestingSelection.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -44,6 +44,7 @@ declare const DescribeBackupVaultCommand_base: {
  * //   BackupVaultName: "STRING_VALUE",
  * //   BackupVaultArn: "STRING_VALUE",
  * //   VaultType: "BACKUP_VAULT" || "LOGICALLY_AIR_GAPPED_BACKUP_VAULT",
+ * //   VaultState: "CREATING" || "AVAILABLE" || "FAILED",
  * //   EncryptionKeyArn: "STRING_VALUE",
  * //   CreationDate: new Date("TIMESTAMP"),
  * //   CreatorRequestId: "STRING_VALUE",

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

@@ -27,8 +27,7 @@ declare const ListBackupPlanTemplatesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns metadata of your saved backup plan templates, including the template ID, name,
- *          and the creation and deletion dates.</p>
+ * <p>Lists the backup plan templates.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,9 +27,7 @@ declare const ListBackupPlansCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a list of all active backup plans for an authenticated account. The list
- *          contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion
- *          dates, version IDs, plan names, and creator request IDs.</p>
+ * <p>Lists the active backup plans for the account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -48,6 +48,8 @@ declare const ListBackupVaultsCommand_base: {
  * //     { // BackupVaultListMember
  * //       BackupVaultName: "STRING_VALUE",
  * //       BackupVaultArn: "STRING_VALUE",
+ * //       VaultType: "BACKUP_VAULT" || "LOGICALLY_AIR_GAPPED_BACKUP_VAULT",
+ * //       VaultState: "CREATING" || "AVAILABLE" || "FAILED",
  * //       CreationDate: new Date("TIMESTAMP"),
  * //       EncryptionKeyArn: "STRING_VALUE",
  * //       CreatorRequestId: "STRING_VALUE",

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

@@ -27,7 +27,7 @@ declare const ListRecoveryPointsByResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns detailed information about all the recovery points of the type specified by a
+ * <p>The information about the recovery points of the type specified by a
  *          resource Amazon Resource Name (ARN).</p>
  *          <note>
  *             <p>For Amazon EFS and Amazon EC2, this action only lists recovery points

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

@@ -27,12 +27,8 @@ declare const ListTagsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a list of key-value pairs assigned to a target recovery point, backup plan, or
+ * <p>Returns the tags assigned to the resource, such as a target recovery point, backup plan, or
  *          backup vault.</p>
- *          <p>
- *             <code>ListTags</code> only works for resource types that support full Backup
- *          management of their backups. Those resource types are listed in the "Full Backup management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
- *             availability by resource</a> table.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -36,10 +36,11 @@ declare const PutBackupVaultLockConfigurationCommand_base: {
  *             <p>Backup Vault Lock has been assessed by Cohasset Associates for use in environments
  *             that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about
  *             how Backup Vault Lock relates to these regulations, see the
- *             <a href="samples/cohassetreport.zip">Cohasset Associates
+ *             <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/samples/cohassetreport.zip">Cohasset Associates
  *                Compliance Assessment.</a>
  *             </p>
  *          </note>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html">Backup Vault Lock</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -29,8 +29,8 @@ declare const StopBackupJobCommand_base: {
 /**
  * <p>Attempts to cancel a job to create a one-time backup of a resource.</p>
  *          <p>This action is not supported for the following services:
- *          Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP
- *          , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora,
+ *          Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP,
+ *          Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora,
  *          and Amazon Neptune.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -29,6 +29,9 @@ declare const TagResourceCommand_base: {
 /**
  * <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>
+ *          <p>This API is supported for recovery points for resource types
+ *          including Aurora, Amazon DocumentDB. Amazon EBS,
+ *          Amazon FSx, Neptune, and Amazon RDS.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -29,6 +29,9 @@ declare const UntagResourceCommand_base: {
 /**
  * <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>
+ *          <p>This API is not supported for recovery points for resource types
+ *          including Aurora, Amazon DocumentDB. Amazon EBS,
+ *          Amazon FSx, Neptune, and Amazon RDS.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,9 +27,7 @@ declare const UpdateBackupPlanCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <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>
+ * <p>Updates the specified backup plan. The new version is uniquely identified by its ID.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,8 +27,7 @@ declare const UpdateFrameworkCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates an existing framework identified by its <code>FrameworkName</code> with the
- *          input document in JSON format.</p>
+ * <p>Updates the specified framework.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -31,14 +31,17 @@ declare const UpdateRecoveryPointLifecycleCommand_base: {
  *          <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
  *          the lifecycle that you define.</p>
+ *          <p>Resource types that can transition to cold storage are listed in the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource">Feature availability by resource</a> table. Backup ignores this expression for
+ *          other resource types.</p>
  *          <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
  *          days. Therefore, the “retention” setting must be 90 days greater than the “transition to
  *          cold after days” setting. The “transition to cold after days” setting cannot be changed
  *          after a backup has been transitioned to cold.</p>
- *          <p>Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage"
- *          section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource">
- *             Feature availability by resource</a> table. Backup ignores this expression for
- *          other resource types.</p>
+ *          <important>
+ *             <p>If your lifecycle currently uses the parameters <code>DeleteAfterDays</code> and
+ *          <code>MoveToColdStorageAfterDays</code>, include these parameters and their values when you call
+ *          this operation. Not including them may result in your plan updating with null values.</p>
+ *          </important>
  *          <p>This operation does not support continuous backups.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -27,8 +27,7 @@ declare const UpdateReportPlanCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates an existing report plan identified by its <code>ReportPlanName</code> with the
- *          input document in JSON format.</p>
+ * <p>Updates the specified report plan.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,14 +27,10 @@ declare const UpdateRestoreTestingSelectionCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Most elements except the <code>RestoreTestingSelectionName</code>
+ * <p>Updates the specified restore testing selection.</p>
+ *          <p>Most elements except the <code>RestoreTestingSelectionName</code>
  *          can be updated with this request.</p>
- *          <p>
- *             <code>RestoreTestingSelection</code> can use either protected
- *          resource ARNs or conditions, but not both. That is, if your selection
- *          has <code>ProtectedResourceArns</code>, requesting an update with the
- *          parameter <code>ProtectedResourceConditions</code> will be
- *          unsuccessful.</p>
+ *          <p>You can use either protected resource ARNs or conditions, but not both.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript