Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PutBackupVaultNotifications

Turns on notifications on a backup vault for the specified topic and events.

Request Syntax


PUT /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
Content-type: application/json

{
   "BackupVaultEvents": [ "string" ],
   "SNSTopicArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

backupVaultName

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

BackupVaultEvents

An array of events that indicate the status of jobs to back up resources to the backup vault.

For common use cases and code samples, see Using Amazon SNS to track AWS Backup events.

The following events are supported:

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

Note

The list below includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the supported events.

Type: Array of strings

Required: Yes

SNSTopicArn

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

Type: String

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ResourceNotFoundException

A resource that is required for the action doesn't exist.

HTTP Status Code: 400

ServiceUnavailableException

The request failed due to a temporary failure of the server.

HTTP Status Code: 500