AWS Backup

{'BackupVaultEvents': {'EKS_BACKUP_OBJECT_FAILED',
                       'EKS_RESTORE_OBJECT_FAILED',
                       'EKS_RESTORE_OBJECT_SKIPPED'}}

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.

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'|'CONTINUOUS_BACKUP_INTERRUPTED'|'RECOVERY_POINT_INDEX_COMPLETED'|'RECOVERY_POINT_INDEX_DELETED'|'RECOVERY_POINT_INDEXING_FAILED'|'EKS_RESTORE_OBJECT_FAILED'|'EKS_RESTORE_OBJECT_SKIPPED'|'EKS_BACKUP_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) --

{'BackupVaultEvents': {'EKS_BACKUP_OBJECT_FAILED',
                       'EKS_RESTORE_OBJECT_FAILED',
                       'EKS_RESTORE_OBJECT_SKIPPED'}}

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'|'CONTINUOUS_BACKUP_INTERRUPTED'|'RECOVERY_POINT_INDEX_COMPLETED'|'RECOVERY_POINT_INDEX_DELETED'|'RECOVERY_POINT_INDEXING_FAILED'|'EKS_RESTORE_OBJECT_FAILED'|'EKS_RESTORE_OBJECT_SKIPPED'|'EKS_BACKUP_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.

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 the list of supported events, common use cases, and code samples, see Notification options with Backup.

• (string) --

returns:

None