@aws-sdk/client-backup 3.821.0 → 3.823.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.
- package/dist-cjs/index.js +7 -1
- package/dist-es/models/models_0.js +6 -0
- package/dist-types/commands/DescribeRecoveryPointCommand.d.ts +1 -1
- package/dist-types/commands/GetBackupVaultNotificationsCommand.d.ts +1 -1
- package/dist-types/commands/ListRecoveryPointsByBackupVaultCommand.d.ts +1 -1
- package/dist-types/commands/ListRecoveryPointsByResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsCommand.d.ts +13 -2
- package/dist-types/commands/PutBackupVaultNotificationsCommand.d.ts +1 -1
- package/dist-types/commands/StopBackupJobCommand.d.ts +30 -4
- package/dist-types/commands/TagResourceCommand.d.ts +1 -5
- package/dist-types/models/models_0.d.ts +165 -50
- package/dist-types/ts3.4/models/models_0.d.ts +6 -0
- package/package.json +5 -5
package/dist-cjs/index.js
CHANGED
|
@@ -464,6 +464,9 @@ var BackupVaultEvent = {
|
|
|
464
464
|
COPY_JOB_FAILED: "COPY_JOB_FAILED",
|
|
465
465
|
COPY_JOB_STARTED: "COPY_JOB_STARTED",
|
|
466
466
|
COPY_JOB_SUCCESSFUL: "COPY_JOB_SUCCESSFUL",
|
|
467
|
+
RECOVERY_POINT_INDEXING_FAILED: "RECOVERY_POINT_INDEXING_FAILED",
|
|
468
|
+
RECOVERY_POINT_INDEX_COMPLETED: "RECOVERY_POINT_INDEX_COMPLETED",
|
|
469
|
+
RECOVERY_POINT_INDEX_DELETED: "RECOVERY_POINT_INDEX_DELETED",
|
|
467
470
|
RECOVERY_POINT_MODIFIED: "RECOVERY_POINT_MODIFIED",
|
|
468
471
|
RESTORE_JOB_COMPLETED: "RESTORE_JOB_COMPLETED",
|
|
469
472
|
RESTORE_JOB_FAILED: "RESTORE_JOB_FAILED",
|
|
@@ -828,10 +831,13 @@ var IndexStatus = {
|
|
|
828
831
|
PENDING: "PENDING"
|
|
829
832
|
};
|
|
830
833
|
var RecoveryPointStatus = {
|
|
834
|
+
AVAILABLE: "AVAILABLE",
|
|
831
835
|
COMPLETED: "COMPLETED",
|
|
836
|
+
CREATING: "CREATING",
|
|
832
837
|
DELETING: "DELETING",
|
|
833
838
|
EXPIRED: "EXPIRED",
|
|
834
|
-
PARTIAL: "PARTIAL"
|
|
839
|
+
PARTIAL: "PARTIAL",
|
|
840
|
+
STOPPED: "STOPPED"
|
|
835
841
|
};
|
|
836
842
|
var StorageClass = {
|
|
837
843
|
COLD: "COLD",
|
|
@@ -67,6 +67,9 @@ export const BackupVaultEvent = {
|
|
|
67
67
|
COPY_JOB_FAILED: "COPY_JOB_FAILED",
|
|
68
68
|
COPY_JOB_STARTED: "COPY_JOB_STARTED",
|
|
69
69
|
COPY_JOB_SUCCESSFUL: "COPY_JOB_SUCCESSFUL",
|
|
70
|
+
RECOVERY_POINT_INDEXING_FAILED: "RECOVERY_POINT_INDEXING_FAILED",
|
|
71
|
+
RECOVERY_POINT_INDEX_COMPLETED: "RECOVERY_POINT_INDEX_COMPLETED",
|
|
72
|
+
RECOVERY_POINT_INDEX_DELETED: "RECOVERY_POINT_INDEX_DELETED",
|
|
70
73
|
RECOVERY_POINT_MODIFIED: "RECOVERY_POINT_MODIFIED",
|
|
71
74
|
RESTORE_JOB_COMPLETED: "RESTORE_JOB_COMPLETED",
|
|
72
75
|
RESTORE_JOB_FAILED: "RESTORE_JOB_FAILED",
|
|
@@ -305,10 +308,13 @@ export const IndexStatus = {
|
|
|
305
308
|
PENDING: "PENDING",
|
|
306
309
|
};
|
|
307
310
|
export const RecoveryPointStatus = {
|
|
311
|
+
AVAILABLE: "AVAILABLE",
|
|
308
312
|
COMPLETED: "COMPLETED",
|
|
313
|
+
CREATING: "CREATING",
|
|
309
314
|
DELETING: "DELETING",
|
|
310
315
|
EXPIRED: "EXPIRED",
|
|
311
316
|
PARTIAL: "PARTIAL",
|
|
317
|
+
STOPPED: "STOPPED",
|
|
312
318
|
};
|
|
313
319
|
export const StorageClass = {
|
|
314
320
|
COLD: "COLD",
|
|
@@ -56,7 +56,7 @@ declare const DescribeRecoveryPointCommand_base: {
|
|
|
56
56
|
* // BackupRuleId: "STRING_VALUE",
|
|
57
57
|
* // },
|
|
58
58
|
* // IamRoleArn: "STRING_VALUE",
|
|
59
|
-
* // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED",
|
|
59
|
+
* // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED" || "AVAILABLE" || "STOPPED" || "CREATING",
|
|
60
60
|
* // StatusMessage: "STRING_VALUE",
|
|
61
61
|
* // CreationDate: new Date("TIMESTAMP"),
|
|
62
62
|
* // CompletionDate: new Date("TIMESTAMP"),
|
|
@@ -44,7 +44,7 @@ declare const GetBackupVaultNotificationsCommand_base: {
|
|
|
44
44
|
* // BackupVaultArn: "STRING_VALUE",
|
|
45
45
|
* // SNSTopicArn: "STRING_VALUE",
|
|
46
46
|
* // BackupVaultEvents: [ // BackupVaultEvents
|
|
47
|
-
* // "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",
|
|
47
|
+
* // "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",
|
|
48
48
|
* // ],
|
|
49
49
|
* // };
|
|
50
50
|
*
|
|
@@ -65,7 +65,7 @@ declare const ListRecoveryPointsByBackupVaultCommand_base: {
|
|
|
65
65
|
* // BackupRuleId: "STRING_VALUE",
|
|
66
66
|
* // },
|
|
67
67
|
* // IamRoleArn: "STRING_VALUE",
|
|
68
|
-
* // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED",
|
|
68
|
+
* // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED" || "AVAILABLE" || "STOPPED" || "CREATING",
|
|
69
69
|
* // StatusMessage: "STRING_VALUE",
|
|
70
70
|
* // CreationDate: new Date("TIMESTAMP"),
|
|
71
71
|
* // CompletionDate: new Date("TIMESTAMP"),
|
|
@@ -53,7 +53,7 @@ declare const ListRecoveryPointsByResourceCommand_base: {
|
|
|
53
53
|
* // { // RecoveryPointByResource
|
|
54
54
|
* // RecoveryPointArn: "STRING_VALUE",
|
|
55
55
|
* // CreationDate: new Date("TIMESTAMP"),
|
|
56
|
-
* // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED",
|
|
56
|
+
* // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED" || "AVAILABLE" || "STOPPED" || "CREATING",
|
|
57
57
|
* // StatusMessage: "STRING_VALUE",
|
|
58
58
|
* // EncryptionKeyArn: "STRING_VALUE",
|
|
59
59
|
* // BackupSizeBytes: Number("long"),
|
|
@@ -27,8 +27,19 @@ declare const ListTagsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns the tags assigned to the resource, such as a target recovery point, backup plan,
|
|
31
|
-
* backup vault.</p>
|
|
30
|
+
* <p>Returns the tags assigned to the resource, such as a target recovery point, backup plan,
|
|
31
|
+
* or backup vault.</p>
|
|
32
|
+
* <p>This operation returns results depending on the resource type used in the value for
|
|
33
|
+
* <code>resourceArn</code>. For example, recovery points of Amazon DynamoDB with
|
|
34
|
+
* Advanced Settings have an ARN (Amazon Resource Name) that begins with
|
|
35
|
+
* <code>arn:aws:backup</code>. Recovery points (backups) of DynamoDB without
|
|
36
|
+
* Advanced Settings enabled have an ARN that begins with
|
|
37
|
+
* <code>arn:aws:dynamodb</code>.</p>
|
|
38
|
+
* <p>When this operation is called and when you include values of <code>resourceArn</code>
|
|
39
|
+
* that have an ARN other than <code>arn:aws:backup</code>, it may return one of the
|
|
40
|
+
* exceptions listed below. To prevent this exception, include only values representing
|
|
41
|
+
* resource types that are fully managed by Backup. These have an ARN that begins
|
|
42
|
+
* <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>
|
|
32
43
|
* @example
|
|
33
44
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
45
|
* ```javascript
|
|
@@ -38,7 +38,7 @@ declare const PutBackupVaultNotificationsCommand_base: {
|
|
|
38
38
|
* BackupVaultName: "STRING_VALUE", // required
|
|
39
39
|
* SNSTopicArn: "STRING_VALUE", // required
|
|
40
40
|
* BackupVaultEvents: [ // BackupVaultEvents // required
|
|
41
|
-
* "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",
|
|
41
|
+
* "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",
|
|
42
42
|
* ],
|
|
43
43
|
* };
|
|
44
44
|
* const command = new PutBackupVaultNotificationsCommand(input);
|
|
@@ -28,10 +28,36 @@ declare const StopBackupJobCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Attempts to cancel a job to create a one-time backup of a resource.</p>
|
|
31
|
-
* <p>This action is not supported for the following services
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
31
|
+
* <p>This action is not supported for the following services:</p>
|
|
32
|
+
* <ul>
|
|
33
|
+
* <li>
|
|
34
|
+
* <p>Amazon Aurora</p>
|
|
35
|
+
* </li>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>Amazon DocumentDB (with MongoDB compatibility)</p>
|
|
38
|
+
* </li>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>Amazon FSx for Lustre</p>
|
|
41
|
+
* </li>
|
|
42
|
+
* <li>
|
|
43
|
+
* <p>Amazon FSx for NetApp ONTAP</p>
|
|
44
|
+
* </li>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>Amazon FSx for OpenZFS</p>
|
|
47
|
+
* </li>
|
|
48
|
+
* <li>
|
|
49
|
+
* <p>Amazon FSx for Windows File Server</p>
|
|
50
|
+
* </li>
|
|
51
|
+
* <li>
|
|
52
|
+
* <p>Amazon Neptune</p>
|
|
53
|
+
* </li>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>SAP HANA databases on Amazon EC2 instances</p>
|
|
56
|
+
* </li>
|
|
57
|
+
* <li>
|
|
58
|
+
* <p>Amazon RDS</p>
|
|
59
|
+
* </li>
|
|
60
|
+
* </ul>
|
|
35
61
|
* @example
|
|
36
62
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
63
|
* ```javascript
|
|
@@ -27,11 +27,7 @@ declare const TagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Assigns a set of key-value pairs to a
|
|
31
|
-
* identified by an Amazon Resource Name (ARN).</p>
|
|
32
|
-
* <p>This API is supported for recovery points for resource types
|
|
33
|
-
* including Aurora, Amazon DocumentDB. Amazon EBS,
|
|
34
|
-
* Amazon FSx, Neptune, and Amazon RDS.</p>
|
|
30
|
+
* <p>Assigns a set of key-value pairs to a resource.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -198,7 +198,44 @@ export interface BackupJob {
|
|
|
198
198
|
*/
|
|
199
199
|
PercentDone?: string | undefined;
|
|
200
200
|
/**
|
|
201
|
-
* <p>The size, in bytes, of a backup.</p>
|
|
201
|
+
* <p>The size, in bytes, of a backup (recovery point).</p>
|
|
202
|
+
* <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
|
|
203
|
+
* value returned may show a value of <code>0</code>, which may differ from the
|
|
204
|
+
* anticipated value.</p>
|
|
205
|
+
* <p>The expected behavior for values by resource type are described as follows:</p>
|
|
206
|
+
* <ul>
|
|
207
|
+
* <li>
|
|
208
|
+
* <p>Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do
|
|
209
|
+
* not have this value populate from the operation
|
|
210
|
+
* <code>GetBackupJobStatus</code>.</p>
|
|
211
|
+
* </li>
|
|
212
|
+
* <li>
|
|
213
|
+
* <p>For Amazon DynamoDB with advanced features, this value refers to the size
|
|
214
|
+
* of the recovery point (backup).</p>
|
|
215
|
+
* </li>
|
|
216
|
+
* <li>
|
|
217
|
+
* <p>Amazon EC2 and Amazon EBS show volume size (provisioned storage)
|
|
218
|
+
* returned as part of this value. Amazon EBS does not return backup size
|
|
219
|
+
* information; snapshot size will have the same value as the original resource that was
|
|
220
|
+
* backed up.</p>
|
|
221
|
+
* </li>
|
|
222
|
+
* <li>
|
|
223
|
+
* <p>For Amazon EFS, this value refers to the delta bytes transferred during a
|
|
224
|
+
* backup.</p>
|
|
225
|
+
* </li>
|
|
226
|
+
* <li>
|
|
227
|
+
* <p>Amazon FSx does not populate this value from the operation
|
|
228
|
+
* <code>GetBackupJobStatus</code> for FSx file systems.</p>
|
|
229
|
+
* </li>
|
|
230
|
+
* <li>
|
|
231
|
+
* <p>An Amazon RDS instance will show as <code>0</code>.</p>
|
|
232
|
+
* </li>
|
|
233
|
+
* <li>
|
|
234
|
+
* <p>For virtual machines running VMware, this value is passed to Backup
|
|
235
|
+
* through an asynchronous workflow, which can mean this displayed value can
|
|
236
|
+
* under-represent the actual backup size.</p>
|
|
237
|
+
* </li>
|
|
238
|
+
* </ul>
|
|
202
239
|
* @public
|
|
203
240
|
*/
|
|
204
241
|
BackupSizeInBytes?: number | undefined;
|
|
@@ -497,12 +534,15 @@ export interface BackupRule {
|
|
|
497
534
|
*/
|
|
498
535
|
TargetBackupVaultName: string | undefined;
|
|
499
536
|
/**
|
|
500
|
-
* <p>A cron expression in UTC specifying when Backup initiates a backup job.
|
|
501
|
-
*
|
|
502
|
-
*
|
|
503
|
-
*
|
|
504
|
-
*
|
|
505
|
-
*
|
|
537
|
+
* <p>A cron expression in UTC specifying when Backup initiates a backup job.
|
|
538
|
+
* When no CRON expression is provided, Backup will use the default
|
|
539
|
+
* expression <code>cron(0 5 ? * * *)</code>.</p>
|
|
540
|
+
* <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
|
|
541
|
+
* Guide</i>.</p>
|
|
542
|
+
* <p>Two examples of Amazon Web Services cron expressions are <code> 15 * ? * * *</code> (take
|
|
543
|
+
* a backup every hour at 15 minutes past the hour) and <code>0 12 * * ? *</code> (take a
|
|
544
|
+
* backup every day at 12 noon UTC).</p>
|
|
545
|
+
* <p>For a table of examples, click the preceding link and scroll down the page.</p>
|
|
506
546
|
* @public
|
|
507
547
|
*/
|
|
508
548
|
ScheduleExpression?: string | undefined;
|
|
@@ -627,7 +667,8 @@ export interface BackupRuleInput {
|
|
|
627
667
|
TargetBackupVaultName: string | undefined;
|
|
628
668
|
/**
|
|
629
669
|
* <p>A CRON expression in UTC specifying when Backup initiates a backup
|
|
630
|
-
* job
|
|
670
|
+
* job. When no CRON expression is provided, Backup will use the default
|
|
671
|
+
* expression <code>cron(0 5 ? * * *)</code>.</p>
|
|
631
672
|
* @public
|
|
632
673
|
*/
|
|
633
674
|
ScheduleExpression?: string | undefined;
|
|
@@ -1026,6 +1067,9 @@ export declare const BackupVaultEvent: {
|
|
|
1026
1067
|
readonly COPY_JOB_FAILED: "COPY_JOB_FAILED";
|
|
1027
1068
|
readonly COPY_JOB_STARTED: "COPY_JOB_STARTED";
|
|
1028
1069
|
readonly COPY_JOB_SUCCESSFUL: "COPY_JOB_SUCCESSFUL";
|
|
1070
|
+
readonly RECOVERY_POINT_INDEXING_FAILED: "RECOVERY_POINT_INDEXING_FAILED";
|
|
1071
|
+
readonly RECOVERY_POINT_INDEX_COMPLETED: "RECOVERY_POINT_INDEX_COMPLETED";
|
|
1072
|
+
readonly RECOVERY_POINT_INDEX_DELETED: "RECOVERY_POINT_INDEX_DELETED";
|
|
1029
1073
|
readonly RECOVERY_POINT_MODIFIED: "RECOVERY_POINT_MODIFIED";
|
|
1030
1074
|
readonly RESTORE_JOB_COMPLETED: "RESTORE_JOB_COMPLETED";
|
|
1031
1075
|
readonly RESTORE_JOB_FAILED: "RESTORE_JOB_FAILED";
|
|
@@ -2465,7 +2509,8 @@ export interface RestoreTestingPlanForCreate {
|
|
|
2465
2509
|
RestoreTestingPlanName: string | undefined;
|
|
2466
2510
|
/**
|
|
2467
2511
|
* <p>A CRON expression in specified timezone when a restore
|
|
2468
|
-
* testing plan is executed
|
|
2512
|
+
* testing plan is executed. When no CRON expression is provided, Backup will use the default
|
|
2513
|
+
* expression <code>cron(0 5 ? * * *)</code>.</p>
|
|
2469
2514
|
* @public
|
|
2470
2515
|
*/
|
|
2471
2516
|
ScheduleExpression: string | undefined;
|
|
@@ -2710,7 +2755,7 @@ export interface RestoreTestingSelectionForCreate {
|
|
|
2710
2755
|
*/
|
|
2711
2756
|
RestoreTestingSelectionName: string | undefined;
|
|
2712
2757
|
/**
|
|
2713
|
-
* <p>This is amount of hours (
|
|
2758
|
+
* <p>This is amount of hours (0 to 168) available to run a validation script on the data. The
|
|
2714
2759
|
* data will be deleted upon the completion of the validation script or the end of the
|
|
2715
2760
|
* specified retention period, whichever comes first.</p>
|
|
2716
2761
|
* @public
|
|
@@ -3062,7 +3107,44 @@ export interface DescribeBackupJobOutput {
|
|
|
3062
3107
|
*/
|
|
3063
3108
|
PercentDone?: string | undefined;
|
|
3064
3109
|
/**
|
|
3065
|
-
* <p>The size, in bytes, of a backup.</p>
|
|
3110
|
+
* <p>The size, in bytes, of a backup (recovery point).</p>
|
|
3111
|
+
* <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
|
|
3112
|
+
* value returned may show a value of <code>0</code>, which may differ from the
|
|
3113
|
+
* anticipated value.</p>
|
|
3114
|
+
* <p>The expected behavior for values by resource type are described as follows:</p>
|
|
3115
|
+
* <ul>
|
|
3116
|
+
* <li>
|
|
3117
|
+
* <p>Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do
|
|
3118
|
+
* not have this value populate from the operation
|
|
3119
|
+
* <code>GetBackupJobStatus</code>.</p>
|
|
3120
|
+
* </li>
|
|
3121
|
+
* <li>
|
|
3122
|
+
* <p>For Amazon DynamoDB with advanced features, this value refers to the size
|
|
3123
|
+
* of the recovery point (backup).</p>
|
|
3124
|
+
* </li>
|
|
3125
|
+
* <li>
|
|
3126
|
+
* <p>Amazon EC2 and Amazon EBS show volume size (provisioned storage)
|
|
3127
|
+
* returned as part of this value. Amazon EBS does not return backup size
|
|
3128
|
+
* information; snapshot size will have the same value as the original resource that was
|
|
3129
|
+
* backed up.</p>
|
|
3130
|
+
* </li>
|
|
3131
|
+
* <li>
|
|
3132
|
+
* <p>For Amazon EFS, this value refers to the delta bytes transferred during a
|
|
3133
|
+
* backup.</p>
|
|
3134
|
+
* </li>
|
|
3135
|
+
* <li>
|
|
3136
|
+
* <p>Amazon FSx does not populate this value from the operation
|
|
3137
|
+
* <code>GetBackupJobStatus</code> for FSx file systems.</p>
|
|
3138
|
+
* </li>
|
|
3139
|
+
* <li>
|
|
3140
|
+
* <p>An Amazon RDS instance will show as <code>0</code>.</p>
|
|
3141
|
+
* </li>
|
|
3142
|
+
* <li>
|
|
3143
|
+
* <p>For virtual machines running VMware, this value is passed to Backup
|
|
3144
|
+
* through an asynchronous workflow, which can mean this displayed value can
|
|
3145
|
+
* under-represent the actual backup size.</p>
|
|
3146
|
+
* </li>
|
|
3147
|
+
* </ul>
|
|
3066
3148
|
* @public
|
|
3067
3149
|
*/
|
|
3068
3150
|
BackupSizeInBytes?: number | undefined;
|
|
@@ -3229,6 +3311,10 @@ export interface DescribeBackupVaultOutput {
|
|
|
3229
3311
|
CreatorRequestId?: string | undefined;
|
|
3230
3312
|
/**
|
|
3231
3313
|
* <p>The number of recovery points that are stored in a backup vault.</p>
|
|
3314
|
+
* <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">
|
|
3315
|
+
* <code>ListRecoveryPointsByBackupVault</code>
|
|
3316
|
+
* </a> API to obtain the exact
|
|
3317
|
+
* count.</p>
|
|
3232
3318
|
* @public
|
|
3233
3319
|
*/
|
|
3234
3320
|
NumberOfRecoveryPoints?: number | undefined;
|
|
@@ -3521,10 +3607,13 @@ export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus];
|
|
|
3521
3607
|
* @enum
|
|
3522
3608
|
*/
|
|
3523
3609
|
export declare const RecoveryPointStatus: {
|
|
3610
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
3524
3611
|
readonly COMPLETED: "COMPLETED";
|
|
3612
|
+
readonly CREATING: "CREATING";
|
|
3525
3613
|
readonly DELETING: "DELETING";
|
|
3526
3614
|
readonly EXPIRED: "EXPIRED";
|
|
3527
3615
|
readonly PARTIAL: "PARTIAL";
|
|
3616
|
+
readonly STOPPED: "STOPPED";
|
|
3528
3617
|
};
|
|
3529
3618
|
/**
|
|
3530
3619
|
* @public
|
|
@@ -3601,32 +3690,55 @@ export interface DescribeRecoveryPointOutput {
|
|
|
3601
3690
|
*/
|
|
3602
3691
|
IamRoleArn?: string | undefined;
|
|
3603
3692
|
/**
|
|
3604
|
-
* <p>A status code specifying the state of the recovery point
|
|
3605
|
-
* <
|
|
3606
|
-
*
|
|
3607
|
-
*
|
|
3608
|
-
*
|
|
3609
|
-
*
|
|
3610
|
-
*
|
|
3611
|
-
*
|
|
3612
|
-
*
|
|
3613
|
-
*
|
|
3614
|
-
*
|
|
3615
|
-
*
|
|
3616
|
-
*
|
|
3617
|
-
*
|
|
3618
|
-
*
|
|
3619
|
-
*
|
|
3620
|
-
*
|
|
3621
|
-
*
|
|
3622
|
-
*
|
|
3623
|
-
*
|
|
3624
|
-
*
|
|
3625
|
-
*
|
|
3626
|
-
*
|
|
3627
|
-
*
|
|
3628
|
-
*
|
|
3629
|
-
*
|
|
3693
|
+
* <p>A status code specifying the state of the recovery point. For more information, see
|
|
3694
|
+
* <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/applicationstackbackups.html#cfnrecoverypointstatus">
|
|
3695
|
+
* Recovery point status</a> in the <i>Backup Developer
|
|
3696
|
+
* Guide</i>.</p>
|
|
3697
|
+
* <ul>
|
|
3698
|
+
* <li>
|
|
3699
|
+
* <p>
|
|
3700
|
+
* <code>CREATING</code> status indicates that an Backup job has been
|
|
3701
|
+
* initiated for a resource. The backup process has started and is actively processing
|
|
3702
|
+
* a backup job for the associated recovery point.</p>
|
|
3703
|
+
* </li>
|
|
3704
|
+
* <li>
|
|
3705
|
+
* <p>
|
|
3706
|
+
* <code>AVAILABLE</code> status indicates that the backup was successfully created
|
|
3707
|
+
* for the recovery point. The backup process has completed without any issues, and the
|
|
3708
|
+
* recovery point is now ready for use.</p>
|
|
3709
|
+
* </li>
|
|
3710
|
+
* <li>
|
|
3711
|
+
* <p>
|
|
3712
|
+
* <code>PARTIAL</code> status indicates a composite recovery point has one or more
|
|
3713
|
+
* nested recovery points that were not in the backup.</p>
|
|
3714
|
+
* </li>
|
|
3715
|
+
* <li>
|
|
3716
|
+
* <p>
|
|
3717
|
+
* <code>EXPIRED</code> status indicates that the recovery point has exceeded its retention
|
|
3718
|
+
* period, but Backup lacks permission or is otherwise unable to delete it. To
|
|
3719
|
+
* 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:
|
|
3720
|
+
* Delete the recovery points</a> in the <i>Clean up resources</i>
|
|
3721
|
+
* section of <i>Getting started</i>.</p>
|
|
3722
|
+
* </li>
|
|
3723
|
+
* <li>
|
|
3724
|
+
* <p>
|
|
3725
|
+
* <code>STOPPED</code> status occurs on a continuous backup where a user has taken some
|
|
3726
|
+
* action that causes the continuous backup to be disabled. This can be caused by the removal
|
|
3727
|
+
* of permissions, turning off versioning, turning off events being sent to EventBridge,
|
|
3728
|
+
* or disabling the EventBridge rules that are put in place by Backup. For
|
|
3729
|
+
* recovery points of Amazon S3, Amazon RDS, and Amazon Aurora
|
|
3730
|
+
* resources, this status occurs when the retention period of a continuous backup rule is
|
|
3731
|
+
* changed.</p>
|
|
3732
|
+
* <p>To resolve <code>STOPPED</code> status, ensure that all requested permissions are in
|
|
3733
|
+
* place and that versioning is enabled on the S3 bucket. Once these conditions are met, the
|
|
3734
|
+
* next instance of a backup rule running will result in a new continuous recovery point being
|
|
3735
|
+
* created. The recovery points with STOPPED status do not need to be deleted.</p>
|
|
3736
|
+
* <p>For SAP HANA on Amazon EC2
|
|
3737
|
+
* <code>STOPPED</code> status occurs due to user action, application misconfiguration, or
|
|
3738
|
+
* backup failure. To ensure that future continuous backups succeed, refer to the recovery
|
|
3739
|
+
* point status and check SAP HANA for details.</p>
|
|
3740
|
+
* </li>
|
|
3741
|
+
* </ul>
|
|
3630
3742
|
* @public
|
|
3631
3743
|
*/
|
|
3632
3744
|
Status?: RecoveryPointStatus | undefined;
|
|
@@ -4814,7 +4926,8 @@ export interface RestoreTestingPlanForGet {
|
|
|
4814
4926
|
RestoreTestingPlanName: string | undefined;
|
|
4815
4927
|
/**
|
|
4816
4928
|
* <p>A CRON expression in specified timezone when a restore
|
|
4817
|
-
* testing plan is executed
|
|
4929
|
+
* testing plan is executed. When no CRON expression is provided, Backup will use the default
|
|
4930
|
+
* expression <code>cron(0 5 ? * * *)</code>.</p>
|
|
4818
4931
|
* @public
|
|
4819
4932
|
*/
|
|
4820
4933
|
ScheduleExpression: string | undefined;
|
|
@@ -7557,8 +7670,9 @@ export interface RestoreTestingPlanForList {
|
|
|
7557
7670
|
*/
|
|
7558
7671
|
RestoreTestingPlanName: string | undefined;
|
|
7559
7672
|
/**
|
|
7560
|
-
* <p>A CRON expression in specified timezone when a restore
|
|
7561
|
-
*
|
|
7673
|
+
* <p>A CRON expression in specified timezone when a restore testing plan is executed. When no
|
|
7674
|
+
* CRON expression is provided, Backup will use the default expression
|
|
7675
|
+
* <code>cron(0 5 ? * * *)</code>.</p>
|
|
7562
7676
|
* @public
|
|
7563
7677
|
*/
|
|
7564
7678
|
ScheduleExpression: string | undefined;
|
|
@@ -7842,7 +7956,7 @@ export interface PutBackupVaultNotificationsInput {
|
|
|
7842
7956
|
* <ul>
|
|
7843
7957
|
* <li>
|
|
7844
7958
|
* <p>
|
|
7845
|
-
* <code>BACKUP_JOB_STARTED</code> | <code>BACKUP_JOB_COMPLETED</code>
|
|
7959
|
+
* <code>BACKUP_JOB_STARTED</code> | <code>BACKUP_JOB_COMPLETED</code> | <code>BACKUP_JOB_FAILED</code>
|
|
7846
7960
|
* </p>
|
|
7847
7961
|
* </li>
|
|
7848
7962
|
* <li>
|
|
@@ -7862,6 +7976,12 @@ export interface PutBackupVaultNotificationsInput {
|
|
|
7862
7976
|
* <code>S3_BACKUP_OBJECT_FAILED</code> | <code>S3_RESTORE_OBJECT_FAILED</code>
|
|
7863
7977
|
* </p>
|
|
7864
7978
|
* </li>
|
|
7979
|
+
* <li>
|
|
7980
|
+
* <p>
|
|
7981
|
+
* <code>RECOVERY_POINT_INDEX_COMPLETED</code> | <code>RECOVERY_POINT_INDEX_DELETED</code> |
|
|
7982
|
+
* <code>RECOVERY_POINT_INDEXING_FAILED</code>
|
|
7983
|
+
* </p>
|
|
7984
|
+
* </li>
|
|
7865
7985
|
* </ul>
|
|
7866
7986
|
* <note>
|
|
7867
7987
|
* <p>The list below includes both supported events and deprecated events that are no longer
|
|
@@ -8365,13 +8485,7 @@ export interface StopBackupJobInput {
|
|
|
8365
8485
|
*/
|
|
8366
8486
|
export interface TagResourceInput {
|
|
8367
8487
|
/**
|
|
8368
|
-
* <p>
|
|
8369
|
-
* the tagged resource.</p>
|
|
8370
|
-
* <p>ARNs that do not include <code>backup</code> are incompatible with tagging.
|
|
8371
|
-
* <code>TagResource</code> and <code>UntagResource</code> with invalid ARNs will
|
|
8372
|
-
* result in an error. Acceptable ARN content can include
|
|
8373
|
-
* <code>arn:aws:backup:us-east</code>. Invalid ARN content may look like
|
|
8374
|
-
* <code>arn:aws:ec2:us-east</code>.</p>
|
|
8488
|
+
* <p>The ARN that uniquely identifies the resource.</p>
|
|
8375
8489
|
* @public
|
|
8376
8490
|
*/
|
|
8377
8491
|
ResourceArn: string | undefined;
|
|
@@ -8763,8 +8877,9 @@ export interface RestoreTestingPlanForUpdate {
|
|
|
8763
8877
|
*/
|
|
8764
8878
|
RecoveryPointSelection?: RestoreTestingRecoveryPointSelection | undefined;
|
|
8765
8879
|
/**
|
|
8766
|
-
* <p>A CRON expression in specified timezone when a restore
|
|
8767
|
-
*
|
|
8880
|
+
* <p>A CRON expression in specified timezone when a restore testing plan is executed. When no
|
|
8881
|
+
* CRON expression is provided, Backup will use the default expression
|
|
8882
|
+
* <code>cron(0 5 ? * * *)</code>.</p>
|
|
8768
8883
|
* @public
|
|
8769
8884
|
*/
|
|
8770
8885
|
ScheduleExpression?: string | undefined;
|
|
@@ -205,6 +205,9 @@ export declare const BackupVaultEvent: {
|
|
|
205
205
|
readonly COPY_JOB_FAILED: "COPY_JOB_FAILED";
|
|
206
206
|
readonly COPY_JOB_STARTED: "COPY_JOB_STARTED";
|
|
207
207
|
readonly COPY_JOB_SUCCESSFUL: "COPY_JOB_SUCCESSFUL";
|
|
208
|
+
readonly RECOVERY_POINT_INDEXING_FAILED: "RECOVERY_POINT_INDEXING_FAILED";
|
|
209
|
+
readonly RECOVERY_POINT_INDEX_COMPLETED: "RECOVERY_POINT_INDEX_COMPLETED";
|
|
210
|
+
readonly RECOVERY_POINT_INDEX_DELETED: "RECOVERY_POINT_INDEX_DELETED";
|
|
208
211
|
readonly RECOVERY_POINT_MODIFIED: "RECOVERY_POINT_MODIFIED";
|
|
209
212
|
readonly RESTORE_JOB_COMPLETED: "RESTORE_JOB_COMPLETED";
|
|
210
213
|
readonly RESTORE_JOB_FAILED: "RESTORE_JOB_FAILED";
|
|
@@ -740,10 +743,13 @@ export declare const IndexStatus: {
|
|
|
740
743
|
};
|
|
741
744
|
export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus];
|
|
742
745
|
export declare const RecoveryPointStatus: {
|
|
746
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
743
747
|
readonly COMPLETED: "COMPLETED";
|
|
748
|
+
readonly CREATING: "CREATING";
|
|
744
749
|
readonly DELETING: "DELETING";
|
|
745
750
|
readonly EXPIRED: "EXPIRED";
|
|
746
751
|
readonly PARTIAL: "PARTIAL";
|
|
752
|
+
readonly STOPPED: "STOPPED";
|
|
747
753
|
};
|
|
748
754
|
export type RecoveryPointStatus =
|
|
749
755
|
(typeof RecoveryPointStatus)[keyof typeof RecoveryPointStatus];
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-backup",
|
|
3
3
|
"description": "AWS SDK for JavaScript Backup Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.823.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-backup",
|
|
@@ -20,17 +20,17 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/core": "3.
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
23
|
+
"@aws-sdk/core": "3.823.0",
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.823.0",
|
|
25
25
|
"@aws-sdk/middleware-host-header": "3.821.0",
|
|
26
26
|
"@aws-sdk/middleware-logger": "3.821.0",
|
|
27
27
|
"@aws-sdk/middleware-recursion-detection": "3.821.0",
|
|
28
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
28
|
+
"@aws-sdk/middleware-user-agent": "3.823.0",
|
|
29
29
|
"@aws-sdk/region-config-resolver": "3.821.0",
|
|
30
30
|
"@aws-sdk/types": "3.821.0",
|
|
31
31
|
"@aws-sdk/util-endpoints": "3.821.0",
|
|
32
32
|
"@aws-sdk/util-user-agent-browser": "3.821.0",
|
|
33
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
33
|
+
"@aws-sdk/util-user-agent-node": "3.823.0",
|
|
34
34
|
"@smithy/config-resolver": "^4.1.4",
|
|
35
35
|
"@smithy/core": "^3.5.1",
|
|
36
36
|
"@smithy/fetch-http-handler": "^5.0.4",
|