Skip to content

Commit 9bec4ef

Browse files
author
awstools
committed
feat(client-backup): You can now subscribe to Amazon SNS notifications and Amazon EventBridge events for backup indexing. You can now receive notifications when a backup index is created, deleted, or fails to create, enhancing your ability to monitor and track your backup operations.
1 parent 195b622 commit 9bec4ef

10 files changed

+266
-82
lines changed

clients/client-backup/src/commands/DescribeRecoveryPointCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ export interface DescribeRecoveryPointCommandOutput extends DescribeRecoveryPoin
5757
* // BackupRuleId: "STRING_VALUE",
5858
* // },
5959
* // IamRoleArn: "STRING_VALUE",
60-
* // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED",
60+
* // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED" || "AVAILABLE" || "STOPPED" || "CREATING",
6161
* // StatusMessage: "STRING_VALUE",
6262
* // CreationDate: new Date("TIMESTAMP"),
6363
* // CompletionDate: new Date("TIMESTAMP"),

clients/client-backup/src/commands/GetBackupVaultNotificationsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export interface GetBackupVaultNotificationsCommandOutput extends GetBackupVault
4848
* // BackupVaultArn: "STRING_VALUE",
4949
* // SNSTopicArn: "STRING_VALUE",
5050
* // BackupVaultEvents: [ // BackupVaultEvents
51-
* // "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",
51+
* // "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",
5252
* // ],
5353
* // };
5454
*

clients/client-backup/src/commands/ListRecoveryPointsByBackupVaultCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ export interface ListRecoveryPointsByBackupVaultCommandOutput
7171
* // BackupRuleId: "STRING_VALUE",
7272
* // },
7373
* // IamRoleArn: "STRING_VALUE",
74-
* // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED",
74+
* // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED" || "AVAILABLE" || "STOPPED" || "CREATING",
7575
* // StatusMessage: "STRING_VALUE",
7676
* // CreationDate: new Date("TIMESTAMP"),
7777
* // CompletionDate: new Date("TIMESTAMP"),

clients/client-backup/src/commands/ListRecoveryPointsByResourceCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export interface ListRecoveryPointsByResourceCommandOutput
5959
* // { // RecoveryPointByResource
6060
* // RecoveryPointArn: "STRING_VALUE",
6161
* // CreationDate: new Date("TIMESTAMP"),
62-
* // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED",
62+
* // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED" || "AVAILABLE" || "STOPPED" || "CREATING",
6363
* // StatusMessage: "STRING_VALUE",
6464
* // EncryptionKeyArn: "STRING_VALUE",
6565
* // BackupSizeBytes: Number("long"),

clients/client-backup/src/commands/ListTagsCommand.ts

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,19 @@ export interface ListTagsCommandInput extends ListTagsInput {}
2828
export interface ListTagsCommandOutput extends ListTagsOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns the tags assigned to the resource, such as a target recovery point, backup plan, or
32-
* backup vault.</p>
31+
* <p>Returns the tags assigned to the resource, such as a target recovery point, backup plan,
32+
* or backup vault.</p>
33+
* <p>This operation returns results depending on the resource type used in the value for
34+
* <code>resourceArn</code>. For example, recovery points of Amazon DynamoDB with
35+
* Advanced Settings have an ARN (Amazon Resource Name) that begins with
36+
* <code>arn:aws:backup</code>. Recovery points (backups) of DynamoDB without
37+
* Advanced Settings enabled have an ARN that begins with
38+
* <code>arn:aws:dynamodb</code>.</p>
39+
* <p>When this operation is called and when you include values of <code>resourceArn</code>
40+
* that have an ARN other than <code>arn:aws:backup</code>, it may return one of the
41+
* exceptions listed below. To prevent this exception, include only values representing
42+
* resource types that are fully managed by Backup. These have an ARN that begins
43+
* <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>
3344
* @example
3445
* Use a bare-bones client and the command you need to make an API call.
3546
* ```javascript

clients/client-backup/src/commands/PutBackupVaultNotificationsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface PutBackupVaultNotificationsCommandOutput extends __MetadataBear
4242
* BackupVaultName: "STRING_VALUE", // required
4343
* SNSTopicArn: "STRING_VALUE", // required
4444
* BackupVaultEvents: [ // BackupVaultEvents // required
45-
* "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",
45+
* "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",
4646
* ],
4747
* };
4848
* const command = new PutBackupVaultNotificationsCommand(input);

clients/client-backup/src/commands/StopBackupJobCommand.ts

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,36 @@ export interface StopBackupJobCommandOutput extends __MetadataBearer {}
2929

3030
/**
3131
* <p>Attempts to cancel a job to create a one-time backup of a resource.</p>
32-
* <p>This action is not supported for the following services:
33-
* Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP,
34-
* Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora,
35-
* and Amazon Neptune.</p>
32+
* <p>This action is not supported for the following services:</p>
33+
* <ul>
34+
* <li>
35+
* <p>Amazon Aurora</p>
36+
* </li>
37+
* <li>
38+
* <p>Amazon DocumentDB (with MongoDB compatibility)</p>
39+
* </li>
40+
* <li>
41+
* <p>Amazon FSx for Lustre</p>
42+
* </li>
43+
* <li>
44+
* <p>Amazon FSx for NetApp ONTAP</p>
45+
* </li>
46+
* <li>
47+
* <p>Amazon FSx for OpenZFS</p>
48+
* </li>
49+
* <li>
50+
* <p>Amazon FSx for Windows File Server</p>
51+
* </li>
52+
* <li>
53+
* <p>Amazon Neptune</p>
54+
* </li>
55+
* <li>
56+
* <p>SAP HANA databases on Amazon EC2 instances</p>
57+
* </li>
58+
* <li>
59+
* <p>Amazon RDS</p>
60+
* </li>
61+
* </ul>
3662
* @example
3763
* Use a bare-bones client and the command you need to make an API call.
3864
* ```javascript

clients/client-backup/src/commands/TagResourceCommand.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,7 @@ export interface TagResourceCommandInput extends TagResourceInput {}
2828
export interface TagResourceCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault
32-
* identified by an Amazon Resource Name (ARN).</p>
33-
* <p>This API is supported for recovery points for resource types
34-
* including Aurora, Amazon DocumentDB. Amazon EBS,
35-
* Amazon FSx, Neptune, and Amazon RDS.</p>
31+
* <p>Assigns a set of key-value pairs to a resource.</p>
3632
* @example
3733
* Use a bare-bones client and the command you need to make an API call.
3834
* ```javascript

0 commit comments

Comments
 (0)