Backup / Client / get_backup_vault_notifications

get_backup_vault_notifications#

Backup.Client.get_backup_vault_notifications(**kwargs)#

Returns event notifications for the specified backup vault.

See also: AWS API Documentation

Request Syntax

response = client.get_backup_vault_notifications(
    BackupVaultName='string'
)
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.

Return type:

dict

Returns:

Response Syntax

{
    'BackupVaultName': 'string',
    'BackupVaultArn': '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',
    ]
}

Response Structure

  • (dict) –

    • BackupVaultName (string) –

      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 Region where they are created.

    • BackupVaultArn (string) –

      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    • SNSTopicArn (string) –

      An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.

    • BackupVaultEvents (list) –

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

      • (string) –

Exceptions

  • Backup.Client.exceptions.ResourceNotFoundException

  • Backup.Client.exceptions.InvalidParameterValueException

  • Backup.Client.exceptions.MissingParameterValueException

  • Backup.Client.exceptions.ServiceUnavailableException