put-backup-vault-notifications¶

Description¶

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

Synopsis¶

  put-backup-vault-notifications
--backup-vault-name <value>
--sns-topic-arn <value>
--backup-vault-events <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

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

--sns-topic-arn (string)

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 .

--backup-vault-events (list)

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)

Syntax:

"string" "string" ...

Where valid values are:
  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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output¶

None

Table of Contents

Feedback

User Guide