put_backup_vault_notifications

put_backup_vault_notifications(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.put_backup_vault_notifications(
    BackupVaultName='string',
    SNSTopicArn='string',
    BackupVaultEvents=[
        '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',
    ]
)

Parameters

• BackupVaultName (string) --

  [REQUIRED]

  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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

• SNSTopicArn (string) --

  [REQUIRED]

  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 .

• BackupVaultEvents (list) --

  [REQUIRED]

  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 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 shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.

  • (string) --

Returns

None

Exceptions

• Backup.Client.exceptions.ResourceNotFoundException
• Backup.Client.exceptions.InvalidParameterValueException
• Backup.Client.exceptions.MissingParameterValueException
• Backup.Client.exceptions.ServiceUnavailableException