npm - @aws-sdk/client-backup - Versions diffs - 3.817.0 → 3.822.0 - Mend

@aws-sdk/client-backup 3.817.0 → 3.822.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 (13) hide show

package/dist-cjs/index.js CHANGED Viewed

@@ -464,6 +464,9 @@ var BackupVaultEvent = {
   COPY_JOB_FAILED: "COPY_JOB_FAILED",
   COPY_JOB_STARTED: "COPY_JOB_STARTED",
   COPY_JOB_SUCCESSFUL: "COPY_JOB_SUCCESSFUL",
+  RECOVERY_POINT_INDEXING_FAILED: "RECOVERY_POINT_INDEXING_FAILED",
+  RECOVERY_POINT_INDEX_COMPLETED: "RECOVERY_POINT_INDEX_COMPLETED",
+  RECOVERY_POINT_INDEX_DELETED: "RECOVERY_POINT_INDEX_DELETED",
   RECOVERY_POINT_MODIFIED: "RECOVERY_POINT_MODIFIED",
   RESTORE_JOB_COMPLETED: "RESTORE_JOB_COMPLETED",
   RESTORE_JOB_FAILED: "RESTORE_JOB_FAILED",
@@ -828,10 +831,13 @@ var IndexStatus = {
   PENDING: "PENDING"
 };
 var RecoveryPointStatus = {
+  AVAILABLE: "AVAILABLE",
   COMPLETED: "COMPLETED",
+  CREATING: "CREATING",
   DELETING: "DELETING",
   EXPIRED: "EXPIRED",
-  PARTIAL: "PARTIAL"
+  PARTIAL: "PARTIAL",
+  STOPPED: "STOPPED"
 };
 var StorageClass = {
   COLD: "COLD",

package/dist-es/models/models_0.js CHANGED Viewed

@@ -67,6 +67,9 @@ export const BackupVaultEvent = {
     COPY_JOB_FAILED: "COPY_JOB_FAILED",
     COPY_JOB_STARTED: "COPY_JOB_STARTED",
     COPY_JOB_SUCCESSFUL: "COPY_JOB_SUCCESSFUL",
+    RECOVERY_POINT_INDEXING_FAILED: "RECOVERY_POINT_INDEXING_FAILED",
+    RECOVERY_POINT_INDEX_COMPLETED: "RECOVERY_POINT_INDEX_COMPLETED",
+    RECOVERY_POINT_INDEX_DELETED: "RECOVERY_POINT_INDEX_DELETED",
     RECOVERY_POINT_MODIFIED: "RECOVERY_POINT_MODIFIED",
     RESTORE_JOB_COMPLETED: "RESTORE_JOB_COMPLETED",
     RESTORE_JOB_FAILED: "RESTORE_JOB_FAILED",
@@ -305,10 +308,13 @@ export const IndexStatus = {
     PENDING: "PENDING",
 };
 export const RecoveryPointStatus = {
+    AVAILABLE: "AVAILABLE",
     COMPLETED: "COMPLETED",
+    CREATING: "CREATING",
     DELETING: "DELETING",
     EXPIRED: "EXPIRED",
     PARTIAL: "PARTIAL",
+    STOPPED: "STOPPED",
 };
 export const StorageClass = {
     COLD: "COLD",

package/dist-types/commands/DescribeRecoveryPointCommand.d.ts CHANGED Viewed

@@ -56,7 +56,7 @@ declare const DescribeRecoveryPointCommand_base: {
  * //     BackupRuleId: "STRING_VALUE",
  * //   },
  * //   IamRoleArn: "STRING_VALUE",
- * //   Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED",
+ * //   Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED" || "AVAILABLE" || "STOPPED" || "CREATING",
  * //   StatusMessage: "STRING_VALUE",
  * //   CreationDate: new Date("TIMESTAMP"),
  * //   CompletionDate: new Date("TIMESTAMP"),

package/dist-types/commands/GetBackupVaultNotificationsCommand.d.ts CHANGED Viewed

@@ -44,7 +44,7 @@ declare const GetBackupVaultNotificationsCommand_base: {
  * //   BackupVaultArn: "STRING_VALUE",
  * //   SNSTopicArn: "STRING_VALUE",
  * //   BackupVaultEvents: [ // BackupVaultEvents
- * //     "BACKUP_JOB_STARTED" || "BACKUP_JOB_COMPLETED" || "BACKUP_JOB_SUCCESSFUL" || "BACKUP_JOB_FAILED" || "BACKUP_JOB_EXPIRED" || "RESTORE_JOB_STARTED" || "RESTORE_JOB_COMPLETED" || "RESTORE_JOB_SUCCESSFUL" || "RESTORE_JOB_FAILED" || "COPY_JOB_STARTED" || "COPY_JOB_SUCCESSFUL" || "COPY_JOB_FAILED" || "RECOVERY_POINT_MODIFIED" || "BACKUP_PLAN_CREATED" || "BACKUP_PLAN_MODIFIED" || "S3_BACKUP_OBJECT_FAILED" || "S3_RESTORE_OBJECT_FAILED",
+ * //     "BACKUP_JOB_STARTED" || "BACKUP_JOB_COMPLETED" || "BACKUP_JOB_SUCCESSFUL" || "BACKUP_JOB_FAILED" || "BACKUP_JOB_EXPIRED" || "RESTORE_JOB_STARTED" || "RESTORE_JOB_COMPLETED" || "RESTORE_JOB_SUCCESSFUL" || "RESTORE_JOB_FAILED" || "COPY_JOB_STARTED" || "COPY_JOB_SUCCESSFUL" || "COPY_JOB_FAILED" || "RECOVERY_POINT_MODIFIED" || "BACKUP_PLAN_CREATED" || "BACKUP_PLAN_MODIFIED" || "S3_BACKUP_OBJECT_FAILED" || "S3_RESTORE_OBJECT_FAILED" || "RECOVERY_POINT_INDEX_COMPLETED" || "RECOVERY_POINT_INDEX_DELETED" || "RECOVERY_POINT_INDEXING_FAILED",
  * //   ],
  * // };
  *

package/dist-types/commands/ListRecoveryPointsByBackupVaultCommand.d.ts CHANGED Viewed

@@ -65,7 +65,7 @@ declare const ListRecoveryPointsByBackupVaultCommand_base: {
  * //         BackupRuleId: "STRING_VALUE",
  * //       },
  * //       IamRoleArn: "STRING_VALUE",
- * //       Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED",
+ * //       Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED" || "AVAILABLE" || "STOPPED" || "CREATING",
  * //       StatusMessage: "STRING_VALUE",
  * //       CreationDate: new Date("TIMESTAMP"),
  * //       CompletionDate: new Date("TIMESTAMP"),

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

@@ -53,7 +53,7 @@ declare const ListRecoveryPointsByResourceCommand_base: {
  * //     { // RecoveryPointByResource
  * //       RecoveryPointArn: "STRING_VALUE",
  * //       CreationDate: new Date("TIMESTAMP"),
- * //       Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED",
+ * //       Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED" || "AVAILABLE" || "STOPPED" || "CREATING",
  * //       StatusMessage: "STRING_VALUE",
  * //       EncryptionKeyArn: "STRING_VALUE",
  * //       BackupSizeBytes: Number("long"),

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

@@ -27,8 +27,19 @@ declare const ListTagsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns the tags assigned to the resource, such as a target recovery point, backup plan, or
- *          backup vault.</p>
+ * <p>Returns the tags assigned to the resource, such as a target recovery point, backup plan,
+ *          or backup vault.</p>
+ *          <p>This operation returns results depending on the resource type used in the value for
+ *             <code>resourceArn</code>. For example, recovery points of Amazon DynamoDB with
+ *          Advanced Settings have an ARN (Amazon Resource Name) that begins with
+ *             <code>arn:aws:backup</code>. Recovery points (backups) of DynamoDB without
+ *          Advanced Settings enabled have an ARN that begins with
+ *          <code>arn:aws:dynamodb</code>.</p>
+ *          <p>When this operation is called and when you include values of <code>resourceArn</code>
+ *          that have an ARN other than <code>arn:aws:backup</code>, it may return one of the
+ *          exceptions listed below. To prevent this exception, include only values representing
+ *          resource types that are fully managed by Backup. These have an ARN that begins
+ *             <code>arn:aws:backup</code> and they are noted 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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/PutBackupVaultNotificationsCommand.d.ts CHANGED Viewed

@@ -38,7 +38,7 @@ declare const PutBackupVaultNotificationsCommand_base: {
  *   BackupVaultName: "STRING_VALUE", // required
  *   SNSTopicArn: "STRING_VALUE", // required
  *   BackupVaultEvents: [ // BackupVaultEvents // required
- *     "BACKUP_JOB_STARTED" || "BACKUP_JOB_COMPLETED" || "BACKUP_JOB_SUCCESSFUL" || "BACKUP_JOB_FAILED" || "BACKUP_JOB_EXPIRED" || "RESTORE_JOB_STARTED" || "RESTORE_JOB_COMPLETED" || "RESTORE_JOB_SUCCESSFUL" || "RESTORE_JOB_FAILED" || "COPY_JOB_STARTED" || "COPY_JOB_SUCCESSFUL" || "COPY_JOB_FAILED" || "RECOVERY_POINT_MODIFIED" || "BACKUP_PLAN_CREATED" || "BACKUP_PLAN_MODIFIED" || "S3_BACKUP_OBJECT_FAILED" || "S3_RESTORE_OBJECT_FAILED",
+ *     "BACKUP_JOB_STARTED" || "BACKUP_JOB_COMPLETED" || "BACKUP_JOB_SUCCESSFUL" || "BACKUP_JOB_FAILED" || "BACKUP_JOB_EXPIRED" || "RESTORE_JOB_STARTED" || "RESTORE_JOB_COMPLETED" || "RESTORE_JOB_SUCCESSFUL" || "RESTORE_JOB_FAILED" || "COPY_JOB_STARTED" || "COPY_JOB_SUCCESSFUL" || "COPY_JOB_FAILED" || "RECOVERY_POINT_MODIFIED" || "BACKUP_PLAN_CREATED" || "BACKUP_PLAN_MODIFIED" || "S3_BACKUP_OBJECT_FAILED" || "S3_RESTORE_OBJECT_FAILED" || "RECOVERY_POINT_INDEX_COMPLETED" || "RECOVERY_POINT_INDEX_DELETED" || "RECOVERY_POINT_INDEXING_FAILED",
  *   ],
  * };
  * const command = new PutBackupVaultNotificationsCommand(input);

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

@@ -28,10 +28,36 @@ 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,
- *          and Amazon Neptune.</p>
+ *          <p>This action is not supported for the following services:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Amazon Aurora</p>
+ *             </li>
+ *             <li>
+ *                <p>Amazon DocumentDB (with MongoDB compatibility)</p>
+ *             </li>
+ *             <li>
+ *                <p>Amazon FSx for Lustre</p>
+ *             </li>
+ *             <li>
+ *                <p>Amazon FSx for NetApp ONTAP</p>
+ *             </li>
+ *             <li>
+ *                <p>Amazon FSx for OpenZFS</p>
+ *             </li>
+ *             <li>
+ *                <p>Amazon FSx for Windows File Server</p>
+ *             </li>
+ *             <li>
+ *                <p>Amazon Neptune</p>
+ *             </li>
+ *             <li>
+ *                <p>SAP HANA databases on Amazon EC2 instances</p>
+ *             </li>
+ *             <li>
+ *                <p>Amazon RDS</p>
+ *             </li>
+ *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,11 +27,7 @@ declare const TagResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <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>
+ * <p>Assigns a set of key-value pairs to a resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/models/models_0.d.ts CHANGED Viewed

@@ -198,7 +198,44 @@ export interface BackupJob {
      */
     PercentDone?: string | undefined;
     /**
-     * <p>The size, in bytes, of a backup.</p>
+     * <p>The size, in bytes, of a backup (recovery point).</p>
+     *          <p>This value can render differently depending on the resource type as Backup pulls in data information from other Amazon Web Services services. For example, the
+     *          value returned may show a value of <code>0</code>, which may differ from the
+     *          anticipated value.</p>
+     *          <p>The expected behavior for values by resource type are described as follows:</p>
+     *          <ul>
+     *             <li>
+     *                <p>Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do
+     *                not have this value populate from the operation
+     *                <code>GetBackupJobStatus</code>.</p>
+     *             </li>
+     *             <li>
+     *                <p>For Amazon DynamoDB with advanced features, this value refers to the size
+     *                of the recovery point (backup).</p>
+     *             </li>
+     *             <li>
+     *                <p>Amazon EC2 and Amazon EBS show volume size (provisioned storage)
+     *                returned as part of this value. Amazon EBS does not return backup size
+     *                information; snapshot size will have the same value as the original resource that was
+     *                backed up.</p>
+     *             </li>
+     *             <li>
+     *                <p>For Amazon EFS, this value refers to the delta bytes transferred during a
+     *                backup.</p>
+     *             </li>
+     *             <li>
+     *                <p>Amazon FSx does not populate this value from the operation
+     *                <code>GetBackupJobStatus</code> for FSx file systems.</p>
+     *             </li>
+     *             <li>
+     *                <p>An Amazon RDS instance will show as <code>0</code>.</p>
+     *             </li>
+     *             <li>
+     *                <p>For virtual machines running VMware, this value is passed to Backup
+     *                through an asynchronous workflow, which can mean this displayed value can
+     *                under-represent the actual backup size.</p>
+     *             </li>
+     *          </ul>
      * @public
      */
     BackupSizeInBytes?: number | undefined;
@@ -497,12 +534,15 @@ export interface BackupRule {
      */
     TargetBackupVaultName: string | undefined;
     /**
-     * <p>A cron expression in UTC specifying when Backup initiates a backup job. For
-     *          more information about Amazon Web Services cron expressions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html">Schedule Expressions for Rules</a> in the <i>Amazon CloudWatch Events User
-     *             Guide.</i>. Two examples of Amazon Web Services cron expressions are <code> 15 * ?
-     *             * * *</code> (take a backup every hour at 15 minutes past the hour) and <code>0 12 * * ?
-     *             *</code> (take a backup every day at 12 noon UTC). For a table of examples, click the
-     *          preceding link and scroll down the page.</p>
+     * <p>A cron expression in UTC specifying when Backup initiates a backup job.
+     *          When no CRON expression is provided, Backup will use the default
+     *          expression <code>cron(0 5 ? * * *)</code>.</p>
+     *          <p>For more information about Amazon Web Services cron expressions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html">Schedule Expressions for Rules</a> in the <i>Amazon CloudWatch Events User
+     *             Guide</i>.</p>
+     *          <p>Two examples of Amazon Web Services cron expressions are <code> 15 * ? * * *</code> (take
+     *          a backup every hour at 15 minutes past the hour) and <code>0 12 * * ? *</code> (take a
+     *          backup every day at 12 noon UTC).</p>
+     *          <p>For a table of examples, click the preceding link and scroll down the page.</p>
      * @public
      */
     ScheduleExpression?: string | undefined;
@@ -627,7 +667,8 @@ export interface BackupRuleInput {
     TargetBackupVaultName: string | undefined;
     /**
      * <p>A CRON expression in UTC specifying when Backup initiates a backup
-     *          job.</p>
+     *          job. When no CRON expression is provided, Backup will use the default
+     *          expression <code>cron(0 5 ? * * *)</code>.</p>
      * @public
      */
     ScheduleExpression?: string | undefined;
@@ -1026,6 +1067,9 @@ export declare const BackupVaultEvent: {
     readonly COPY_JOB_FAILED: "COPY_JOB_FAILED";
     readonly COPY_JOB_STARTED: "COPY_JOB_STARTED";
     readonly COPY_JOB_SUCCESSFUL: "COPY_JOB_SUCCESSFUL";
+    readonly RECOVERY_POINT_INDEXING_FAILED: "RECOVERY_POINT_INDEXING_FAILED";
+    readonly RECOVERY_POINT_INDEX_COMPLETED: "RECOVERY_POINT_INDEX_COMPLETED";
+    readonly RECOVERY_POINT_INDEX_DELETED: "RECOVERY_POINT_INDEX_DELETED";
     readonly RECOVERY_POINT_MODIFIED: "RECOVERY_POINT_MODIFIED";
     readonly RESTORE_JOB_COMPLETED: "RESTORE_JOB_COMPLETED";
     readonly RESTORE_JOB_FAILED: "RESTORE_JOB_FAILED";
@@ -2465,7 +2509,8 @@ export interface RestoreTestingPlanForCreate {
     RestoreTestingPlanName: string | undefined;
     /**
      * <p>A CRON expression in specified timezone when a restore
-     *          testing plan is executed.</p>
+     *          testing plan is executed. When no CRON expression is provided, Backup will use the default
+     *          expression <code>cron(0 5 ? * * *)</code>.</p>
      * @public
      */
     ScheduleExpression: string | undefined;
@@ -2710,7 +2755,7 @@ export interface RestoreTestingSelectionForCreate {
      */
     RestoreTestingSelectionName: string | undefined;
     /**
-     * <p>This is amount of hours (1 to 168) available to run a validation script on the data. The
+     * <p>This is amount of hours (0 to 168) available to run a validation script on the data. The
      *          data will be deleted upon the completion of the validation script or the end of the
      *          specified retention period, whichever comes first.</p>
      * @public
@@ -3062,7 +3107,44 @@ export interface DescribeBackupJobOutput {
      */
     PercentDone?: string | undefined;
     /**
-     * <p>The size, in bytes, of a backup.</p>
+     * <p>The size, in bytes, of a backup (recovery point).</p>
+     *          <p>This value can render differently depending on the resource type as Backup pulls in data information from other Amazon Web Services services. For example, the
+     *          value returned may show a value of <code>0</code>, which may differ from the
+     *          anticipated value.</p>
+     *          <p>The expected behavior for values by resource type are described as follows:</p>
+     *          <ul>
+     *             <li>
+     *                <p>Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do
+     *                not have this value populate from the operation
+     *                <code>GetBackupJobStatus</code>.</p>
+     *             </li>
+     *             <li>
+     *                <p>For Amazon DynamoDB with advanced features, this value refers to the size
+     *                of the recovery point (backup).</p>
+     *             </li>
+     *             <li>
+     *                <p>Amazon EC2 and Amazon EBS show volume size (provisioned storage)
+     *                returned as part of this value. Amazon EBS does not return backup size
+     *                information; snapshot size will have the same value as the original resource that was
+     *                backed up.</p>
+     *             </li>
+     *             <li>
+     *                <p>For Amazon EFS, this value refers to the delta bytes transferred during a
+     *                backup.</p>
+     *             </li>
+     *             <li>
+     *                <p>Amazon FSx does not populate this value from the operation
+     *                <code>GetBackupJobStatus</code> for FSx file systems.</p>
+     *             </li>
+     *             <li>
+     *                <p>An Amazon RDS instance will show as <code>0</code>.</p>
+     *             </li>
+     *             <li>
+     *                <p>For virtual machines running VMware, this value is passed to Backup
+     *                through an asynchronous workflow, which can mean this displayed value can
+     *                under-represent the actual backup size.</p>
+     *             </li>
+     *          </ul>
      * @public
      */
     BackupSizeInBytes?: number | undefined;
@@ -3229,6 +3311,10 @@ export interface DescribeBackupVaultOutput {
     CreatorRequestId?: string | undefined;
     /**
      * <p>The number of recovery points that are stored in a backup vault.</p>
+     *          <p>Recovery point count value displayed in the console can be an approximation. Use <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html">
+     *                <code>ListRecoveryPointsByBackupVault</code>
+     *             </a> API to obtain the exact
+     *          count.</p>
      * @public
      */
     NumberOfRecoveryPoints?: number | undefined;
@@ -3521,10 +3607,13 @@ export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus];
  * @enum
  */
 export declare const RecoveryPointStatus: {
+    readonly AVAILABLE: "AVAILABLE";
     readonly COMPLETED: "COMPLETED";
+    readonly CREATING: "CREATING";
     readonly DELETING: "DELETING";
     readonly EXPIRED: "EXPIRED";
     readonly PARTIAL: "PARTIAL";
+    readonly STOPPED: "STOPPED";
 };
 /**
  * @public
@@ -3601,32 +3690,55 @@ export interface DescribeRecoveryPointOutput {
      */
     IamRoleArn?: string | undefined;
     /**
-     * <p>A status code specifying the state of the recovery point.</p>
-     *          <p>
-     *             <code>PARTIAL</code> status indicates Backup could not create the recovery
-     *          point before the backup window closed. To increase your backup plan window using the API,
-     *          see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_UpdateBackupPlan.html">UpdateBackupPlan</a>. You can also increase your backup plan window using the
-     *          Console by choosing and editing your backup plan.</p>
-     *          <p>
-     *             <code>EXPIRED</code> status indicates that the recovery point has exceeded its retention
-     *          period, but Backup lacks permission or is otherwise unable to delete it. To
-     *          manually delete these recovery points, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups"> Step 3:
-     *             Delete the recovery points</a> in the <i>Clean up resources</i>
-     *          section of <i>Getting started</i>.</p>
-     *          <p>
-     *             <code>STOPPED</code> status occurs on a continuous backup where a user has taken some
-     *          action that causes the continuous backup to be disabled. This can be caused by the removal
-     *          of permissions, turning off versioning, turning off events being sent to EventBridge,
-     *          or disabling the EventBridge rules that are put in place by Backup. For
-     *          recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status
-     *          occurs when the retention period of a continuous backup rule is changed.</p>
-     *          <p>To resolve <code>STOPPED</code> status, ensure that all requested permissions are in place and
-     *          that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance
-     *          of a backup rule running will result in a new continuous recovery point being created.
-     *          The recovery points with STOPPED status do not need to be deleted.</p>
-     *          <p>For SAP HANA on Amazon EC2 <code>STOPPED</code> status occurs due to user action, application
-     *          misconfiguration, or backup failure. To ensure that future continuous backups succeed,
-     *          refer to the recovery point status and check SAP HANA for details.</p>
+     * <p>A status code specifying the state of the recovery point. For more information, see
+     *          <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/applicationstackbackups.html#cfnrecoverypointstatus">
+     *             Recovery point status</a> in the <i>Backup Developer
+     *                Guide</i>.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>CREATING</code> status indicates that an Backup job has been
+     *                initiated for a resource. The backup process has started and is actively processing
+     *                a backup job for the associated recovery point.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>AVAILABLE</code> status indicates that the backup was successfully created
+     *                for the recovery point. The backup process has completed without any issues, and the
+     *                recovery point is now ready for use.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>PARTIAL</code> status indicates a composite recovery point has one or more
+     *                nested recovery points that were not in the backup.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>EXPIRED</code> status indicates that the recovery point has exceeded its retention
+     *                period, but Backup lacks permission or is otherwise unable to delete it. To
+     *                manually delete these recovery points, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups"> Step 3:
+     *                   Delete the recovery points</a> in the <i>Clean up resources</i>
+     *                section of <i>Getting started</i>.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>STOPPED</code> status occurs on a continuous backup where a user has taken some
+     *                action that causes the continuous backup to be disabled. This can be caused by the removal
+     *                of permissions, turning off versioning, turning off events being sent to EventBridge,
+     *                or disabling the EventBridge rules that are put in place by Backup. For
+     *                recovery points of Amazon S3, Amazon RDS, and Amazon Aurora
+     *                resources, this status occurs when the retention period of a continuous backup rule is
+     *                changed.</p>
+     *                <p>To resolve <code>STOPPED</code> status, ensure that all requested permissions are in
+     *                place and that versioning is enabled on the S3 bucket. Once these conditions are met, the
+     *                next instance of a backup rule running will result in a new continuous recovery point being
+     *                created. The recovery points with STOPPED status do not need to be deleted.</p>
+     *                <p>For SAP HANA on Amazon EC2
+     *                <code>STOPPED</code> status occurs due to user action, application misconfiguration, or
+     *                backup failure. To ensure that future continuous backups succeed, refer to the recovery
+     *                point status and check SAP HANA for details.</p>
+     *             </li>
+     *          </ul>
      * @public
      */
     Status?: RecoveryPointStatus | undefined;
@@ -4814,7 +4926,8 @@ export interface RestoreTestingPlanForGet {
     RestoreTestingPlanName: string | undefined;
     /**
      * <p>A CRON expression in specified timezone when a restore
-     *          testing plan is executed.</p>
+     *          testing plan is executed. When no CRON expression is provided, Backup will use the default
+     *          expression <code>cron(0 5 ? * * *)</code>.</p>
      * @public
      */
     ScheduleExpression: string | undefined;
@@ -7557,8 +7670,9 @@ export interface RestoreTestingPlanForList {
      */
     RestoreTestingPlanName: string | undefined;
     /**
-     * <p>A CRON expression in specified timezone when a restore
-     *          testing plan is executed.</p>
+     * <p>A CRON expression in specified timezone when a restore testing plan is executed. When no
+     *          CRON expression is provided, Backup will use the default expression
+     *             <code>cron(0 5 ? * * *)</code>.</p>
      * @public
      */
     ScheduleExpression: string | undefined;
@@ -7842,7 +7956,7 @@ export interface PutBackupVaultNotificationsInput {
      *          <ul>
      *             <li>
      *                <p>
-     *                   <code>BACKUP_JOB_STARTED</code> | <code>BACKUP_JOB_COMPLETED</code>
+     *                   <code>BACKUP_JOB_STARTED</code> | <code>BACKUP_JOB_COMPLETED</code> | <code>BACKUP_JOB_FAILED</code>
      *                </p>
      *             </li>
      *             <li>
@@ -7862,6 +7976,12 @@ export interface PutBackupVaultNotificationsInput {
      *                   <code>S3_BACKUP_OBJECT_FAILED</code> | <code>S3_RESTORE_OBJECT_FAILED</code>
      *                </p>
      *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>RECOVERY_POINT_INDEX_COMPLETED</code> | <code>RECOVERY_POINT_INDEX_DELETED</code> |
+     *                <code>RECOVERY_POINT_INDEXING_FAILED</code>
+     *                </p>
+     *             </li>
      *          </ul>
      *          <note>
      *             <p>The list below includes both supported events and deprecated events that are no longer
@@ -8365,13 +8485,7 @@ export interface StopBackupJobInput {
  */
 export interface TagResourceInput {
     /**
-     * <p>An ARN that uniquely identifies a resource. The format of the ARN depends on the type of
-     *          the tagged resource.</p>
-     *          <p>ARNs that do not include <code>backup</code> are incompatible with tagging.
-     *       <code>TagResource</code> and <code>UntagResource</code> with invalid ARNs will
-     *       result in an error. Acceptable ARN content can include
-     *          <code>arn:aws:backup:us-east</code>. Invalid ARN content may look like
-     *       <code>arn:aws:ec2:us-east</code>.</p>
+     * <p>The ARN that uniquely identifies the resource.</p>
      * @public
      */
     ResourceArn: string | undefined;
@@ -8763,8 +8877,9 @@ export interface RestoreTestingPlanForUpdate {
      */
     RecoveryPointSelection?: RestoreTestingRecoveryPointSelection | undefined;
     /**
-     * <p>A CRON expression in specified timezone when a restore
-     *          testing plan is executed.</p>
+     * <p>A CRON expression in specified timezone when a restore testing plan is executed. When no
+     *          CRON expression is provided, Backup will use the default expression
+     *             <code>cron(0 5 ? * * *)</code>.</p>
      * @public
      */
     ScheduleExpression?: string | undefined;

package/dist-types/ts3.4/models/models_0.d.ts CHANGED Viewed

@@ -205,6 +205,9 @@ export declare const BackupVaultEvent: {
   readonly COPY_JOB_FAILED: "COPY_JOB_FAILED";
   readonly COPY_JOB_STARTED: "COPY_JOB_STARTED";
   readonly COPY_JOB_SUCCESSFUL: "COPY_JOB_SUCCESSFUL";
+  readonly RECOVERY_POINT_INDEXING_FAILED: "RECOVERY_POINT_INDEXING_FAILED";
+  readonly RECOVERY_POINT_INDEX_COMPLETED: "RECOVERY_POINT_INDEX_COMPLETED";
+  readonly RECOVERY_POINT_INDEX_DELETED: "RECOVERY_POINT_INDEX_DELETED";
   readonly RECOVERY_POINT_MODIFIED: "RECOVERY_POINT_MODIFIED";
   readonly RESTORE_JOB_COMPLETED: "RESTORE_JOB_COMPLETED";
   readonly RESTORE_JOB_FAILED: "RESTORE_JOB_FAILED";
@@ -740,10 +743,13 @@ export declare const IndexStatus: {
 };
 export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus];
 export declare const RecoveryPointStatus: {
+  readonly AVAILABLE: "AVAILABLE";
   readonly COMPLETED: "COMPLETED";
+  readonly CREATING: "CREATING";
   readonly DELETING: "DELETING";
   readonly EXPIRED: "EXPIRED";
   readonly PARTIAL: "PARTIAL";
+  readonly STOPPED: "STOPPED";
 };
 export type RecoveryPointStatus =
   (typeof RecoveryPointStatus)[keyof typeof RecoveryPointStatus];

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-backup",
   "description": "AWS SDK for JavaScript Backup Client for Node.js, Browser and React Native",
-  "version": "3.817.0",
+  "version": "3.822.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-backup",
@@ -20,41 +20,41 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/core": "3.816.0",
-    "@aws-sdk/credential-provider-node": "3.817.0",
-    "@aws-sdk/middleware-host-header": "3.804.0",
-    "@aws-sdk/middleware-logger": "3.804.0",
-    "@aws-sdk/middleware-recursion-detection": "3.804.0",
-    "@aws-sdk/middleware-user-agent": "3.816.0",
-    "@aws-sdk/region-config-resolver": "3.808.0",
-    "@aws-sdk/types": "3.804.0",
-    "@aws-sdk/util-endpoints": "3.808.0",
-    "@aws-sdk/util-user-agent-browser": "3.804.0",
-    "@aws-sdk/util-user-agent-node": "3.816.0",
-    "@smithy/config-resolver": "^4.1.2",
-    "@smithy/core": "^3.3.3",
-    "@smithy/fetch-http-handler": "^5.0.2",
-    "@smithy/hash-node": "^4.0.2",
-    "@smithy/invalid-dependency": "^4.0.2",
-    "@smithy/middleware-content-length": "^4.0.2",
-    "@smithy/middleware-endpoint": "^4.1.6",
-    "@smithy/middleware-retry": "^4.1.7",
-    "@smithy/middleware-serde": "^4.0.5",
-    "@smithy/middleware-stack": "^4.0.2",
-    "@smithy/node-config-provider": "^4.1.1",
-    "@smithy/node-http-handler": "^4.0.4",
-    "@smithy/protocol-http": "^5.1.0",
-    "@smithy/smithy-client": "^4.2.6",
-    "@smithy/types": "^4.2.0",
-    "@smithy/url-parser": "^4.0.2",
+    "@aws-sdk/core": "3.821.0",
+    "@aws-sdk/credential-provider-node": "3.821.0",
+    "@aws-sdk/middleware-host-header": "3.821.0",
+    "@aws-sdk/middleware-logger": "3.821.0",
+    "@aws-sdk/middleware-recursion-detection": "3.821.0",
+    "@aws-sdk/middleware-user-agent": "3.821.0",
+    "@aws-sdk/region-config-resolver": "3.821.0",
+    "@aws-sdk/types": "3.821.0",
+    "@aws-sdk/util-endpoints": "3.821.0",
+    "@aws-sdk/util-user-agent-browser": "3.821.0",
+    "@aws-sdk/util-user-agent-node": "3.821.0",
+    "@smithy/config-resolver": "^4.1.4",
+    "@smithy/core": "^3.5.1",
+    "@smithy/fetch-http-handler": "^5.0.4",
+    "@smithy/hash-node": "^4.0.4",
+    "@smithy/invalid-dependency": "^4.0.4",
+    "@smithy/middleware-content-length": "^4.0.4",
+    "@smithy/middleware-endpoint": "^4.1.9",
+    "@smithy/middleware-retry": "^4.1.10",
+    "@smithy/middleware-serde": "^4.0.8",
+    "@smithy/middleware-stack": "^4.0.4",
+    "@smithy/node-config-provider": "^4.1.3",
+    "@smithy/node-http-handler": "^4.0.6",
+    "@smithy/protocol-http": "^5.1.2",
+    "@smithy/smithy-client": "^4.4.1",
+    "@smithy/types": "^4.3.1",
+    "@smithy/url-parser": "^4.0.4",
     "@smithy/util-base64": "^4.0.0",
     "@smithy/util-body-length-browser": "^4.0.0",
     "@smithy/util-body-length-node": "^4.0.0",
-    "@smithy/util-defaults-mode-browser": "^4.0.14",
-    "@smithy/util-defaults-mode-node": "^4.0.14",
-    "@smithy/util-endpoints": "^3.0.4",
-    "@smithy/util-middleware": "^4.0.2",
-    "@smithy/util-retry": "^4.0.3",
+    "@smithy/util-defaults-mode-browser": "^4.0.17",
+    "@smithy/util-defaults-mode-node": "^4.0.17",
+    "@smithy/util-endpoints": "^3.0.6",
+    "@smithy/util-middleware": "^4.0.4",
+    "@smithy/util-retry": "^4.0.5",
     "@smithy/util-utf8": "^4.0.0",
     "@types/uuid": "^9.0.1",
     "tslib": "^2.6.2",