AWS Backup

2022/02/17 - AWS Backup - 2 updated api methods

Changes  AWS Backup add new S3_BACKUP_OBJECT_FAILED and S3_RESTORE_OBJECT_FAILED event types in BackupVaultNotifications events list.

GetBackupVaultNotifications (updated) Link ¶
Changes (response)
{'BackupVaultEvents': {'S3_RESTORE_OBJECT_FAILED', 'S3_BACKUP_OBJECT_FAILED'}}

Returns event notifications for the specified backup vault.

See also: AWS API Documentation

Request Syntax

client.get_backup_vault_notifications(
    BackupVaultName='string'
)
type BackupVaultName

string

param BackupVaultName

[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.

rtype

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. They consist of lowercase letters, numbers, and hyphens.

    • BackupVaultArn (string) --

      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012: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) --

PutBackupVaultNotifications (updated) Link ¶
Changes (request)
{'BackupVaultEvents': {'S3_RESTORE_OBJECT_FAILED', 'S3_BACKUP_OBJECT_FAILED'}}

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

See also: AWS API Documentation

Request Syntax

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',
    ]
)
type BackupVaultName

string

param BackupVaultName

[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.

type SNSTopicArn

string

param SNSTopicArn

[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 .

type BackupVaultEvents

list

param BackupVaultEvents

[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

Ignore the list below because it includes deprecated events. Refer to the list above.

  • (string) --

returns

None