PutBackupVaultNotifications - AWS Backup

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

PutBackupVaultNotifications

在备份库上为指定主题和事件开启通知。

请求语法

PUT /backup-vaults/backupVaultName/notification-configuration HTTP/1.1 Content-type: application/json { "BackupVaultEvents": [ "string" ], "SNSTopicArn": "string" }

URI 请求参数

请求使用以下 URI 参数。

backupVaultName

用于存储备份的逻辑容器的名称。备份文件库由用于创建它们的账户和创建它们的 AWS 区域所特有的名称标识。它们包含小写字母、数字和连字符。

模式:^[a-zA-Z0-9\-\_]{2,50}$

必需:是

请求正文

请求接受采用 JSON 格式的以下数据。

BackupVaultEvents

一个事件数组,指示将资源备份到备份文件库的作业状态。

有关常见用例和代码示例,请参阅使用 Amazon SNS 跟踪AWS Backup事件

支持以下事件:

  • BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED

  • COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED

  • RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_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

必需:是

SNSTopicArn

为备份文件库的事件指定主题的 Amazon 资源名称 (ARN);例如,arn:aws:sns:us-west-2:111122223333:MyVaultTopic

类型:字符串

必需:是

响应语法

HTTP/1.1 200

响应元素

如果此操作成功,则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

错误

有关所有操作常见错误的信息,请参阅常见错误

InvalidParameterValueException

表示参数的值有问题。例如,该值超出范围。

HTTP 状态代码:400

MissingParameterValueException

表示缺少必填参数。

HTTP 状态代码:400

ResourceNotFoundException

操作所需的资源不存在。

HTTP 状态代码:400

ServiceUnavailableException

由于服务器发生临时故障而导致请求失败。

HTTP 状态代码:500

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: