Amazonka.Backup.PutBackupVaultNotifications

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

Creating a Request

data PutBackupVaultNotifications

See: newPutBackupVaultNotifications smart constructor.

Constructors

PutBackupVaultNotifications'

Fields

• backupVaultName :: Text

  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 :: Text

  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 :: [BackupVaultEvent]

  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

  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.

Instances

ToJSON PutBackupVaultNotifications

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

toJSON :: PutBackupVaultNotifications -> Value

toEncoding :: PutBackupVaultNotifications -> Encoding

toJSONList :: [PutBackupVaultNotifications] -> Value

toEncodingList :: [PutBackupVaultNotifications] -> Encoding

ToHeaders PutBackupVaultNotifications

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

toHeaders :: PutBackupVaultNotifications -> [Header]

ToPath PutBackupVaultNotifications

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

toPath :: PutBackupVaultNotifications -> ByteString

ToQuery PutBackupVaultNotifications

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

toQuery :: PutBackupVaultNotifications -> QueryString

AWSRequest PutBackupVaultNotifications

Defined in Amazonka.Backup.PutBackupVaultNotifications

Associated Types

type AWSResponse PutBackupVaultNotifications

Methods

request :: (Service -> Service) -> PutBackupVaultNotifications -> Request PutBackupVaultNotifications

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutBackupVaultNotifications -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutBackupVaultNotifications)))

Generic PutBackupVaultNotifications

Defined in Amazonka.Backup.PutBackupVaultNotifications

Associated Types

type Rep PutBackupVaultNotifications :: Type -> Type

Methods

from :: PutBackupVaultNotifications -> Rep PutBackupVaultNotifications x

to :: Rep PutBackupVaultNotifications x -> PutBackupVaultNotifications

Read PutBackupVaultNotifications

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

readsPrec :: Int -> ReadS PutBackupVaultNotifications

readList :: ReadS [PutBackupVaultNotifications]

readPrec :: ReadPrec PutBackupVaultNotifications

readListPrec :: ReadPrec [PutBackupVaultNotifications]

Show PutBackupVaultNotifications

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

showsPrec :: Int -> PutBackupVaultNotifications -> ShowS

show :: PutBackupVaultNotifications -> String

showList :: [PutBackupVaultNotifications] -> ShowS

NFData PutBackupVaultNotifications

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

rnf :: PutBackupVaultNotifications -> ()

Eq PutBackupVaultNotifications

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

(==) :: PutBackupVaultNotifications -> PutBackupVaultNotifications -> Bool

(/=) :: PutBackupVaultNotifications -> PutBackupVaultNotifications -> Bool

Hashable PutBackupVaultNotifications

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

hashWithSalt :: Int -> PutBackupVaultNotifications -> Int

hash :: PutBackupVaultNotifications -> Int

type AWSResponse PutBackupVaultNotifications

Defined in Amazonka.Backup.PutBackupVaultNotifications

type AWSResponse PutBackupVaultNotifications = PutBackupVaultNotificationsResponse

type Rep PutBackupVaultNotifications

Defined in Amazonka.Backup.PutBackupVaultNotifications

type Rep PutBackupVaultNotifications = D1 ('MetaData "PutBackupVaultNotifications" "Amazonka.Backup.PutBackupVaultNotifications" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "PutBackupVaultNotifications'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupVaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sNSTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "backupVaultEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BackupVaultEvent]))))

newPutBackupVaultNotifications

Arguments

:: Text

PutBackupVaultNotifications

-> Text

$sel:sNSTopicArn:PutBackupVaultNotifications'

-> PutBackupVaultNotifications

Create a value of PutBackupVaultNotifications with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutBackupVaultNotifications, putBackupVaultNotifications_backupVaultName - 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.

$sel:sNSTopicArn:PutBackupVaultNotifications', putBackupVaultNotifications_sNSTopicArn - 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.

$sel:backupVaultEvents:PutBackupVaultNotifications', putBackupVaultNotifications_backupVaultEvents - 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

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.

Request Lenses

putBackupVaultNotifications_backupVaultName :: Lens' PutBackupVaultNotifications Text

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.

putBackupVaultNotifications_sNSTopicArn :: Lens' PutBackupVaultNotifications Text

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.

putBackupVaultNotifications_backupVaultEvents :: Lens' PutBackupVaultNotifications [BackupVaultEvent]

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

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.

Destructuring the Response

data PutBackupVaultNotificationsResponse

See: newPutBackupVaultNotificationsResponse smart constructor.

Constructors

PutBackupVaultNotificationsResponse'

Instances

Generic PutBackupVaultNotificationsResponse

Defined in Amazonka.Backup.PutBackupVaultNotifications

Associated Types

type Rep PutBackupVaultNotificationsResponse :: Type -> Type

Methods

from :: PutBackupVaultNotificationsResponse -> Rep PutBackupVaultNotificationsResponse x

to :: Rep PutBackupVaultNotificationsResponse x -> PutBackupVaultNotificationsResponse

Read PutBackupVaultNotificationsResponse

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

readsPrec :: Int -> ReadS PutBackupVaultNotificationsResponse

readList :: ReadS [PutBackupVaultNotificationsResponse]

readPrec :: ReadPrec PutBackupVaultNotificationsResponse

readListPrec :: ReadPrec [PutBackupVaultNotificationsResponse]

Show PutBackupVaultNotificationsResponse

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

showsPrec :: Int -> PutBackupVaultNotificationsResponse -> ShowS

show :: PutBackupVaultNotificationsResponse -> String

showList :: [PutBackupVaultNotificationsResponse] -> ShowS

NFData PutBackupVaultNotificationsResponse

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

rnf :: PutBackupVaultNotificationsResponse -> ()

Eq PutBackupVaultNotificationsResponse

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

(==) :: PutBackupVaultNotificationsResponse -> PutBackupVaultNotificationsResponse -> Bool

(/=) :: PutBackupVaultNotificationsResponse -> PutBackupVaultNotificationsResponse -> Bool

type Rep PutBackupVaultNotificationsResponse

Defined in Amazonka.Backup.PutBackupVaultNotifications

type Rep PutBackupVaultNotificationsResponse = D1 ('MetaData "PutBackupVaultNotificationsResponse" "Amazonka.Backup.PutBackupVaultNotifications" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "PutBackupVaultNotificationsResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutBackupVaultNotificationsResponse :: PutBackupVaultNotificationsResponse

Create a value of PutBackupVaultNotificationsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.