翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
PutBackupVaultNotifications
指定されたトピックとイベントのバックアップボールトの通知をオンにします。
リクエストの構文
PUT /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
Content-type: application/json
{
"BackupVaultEvents": [ "string" ],
"SNSTopicArn": "string"
}URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- backupVaultName
-
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。
Pattern:
^[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
-
たとえば、
arn:aws:sns:us-west-2:111122223333:MyVaultTopicなどのバックアップボールトのイベントのトピックを指定する Amazon リソースネーム (ARN)。型: 文字列
必須: はい
レスポンスの構文
HTTP/1.1 200
レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InvalidParameterValueException
-
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。
HTTP ステータスコード：400
- MissingParameterValueException
-
必須パラメータがないことを示します。
HTTP ステータスコード：400
- ResourceNotFoundException
-
アクションに必要なリソースは存在しません。
HTTP ステータスコード：400
- ServiceUnavailableException
-
サーバーの一時的障害のため、リクエストは失敗しました。
HTTP ステータスコード：500
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
