amazonka-backup-2.0: Amazon Backup SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Backup.PutBackupVaultNotifications

Description

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

Synopsis

Creating a Request

data PutBackupVaultNotifications Source #

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

Instances details
ToJSON PutBackupVaultNotifications Source # 
Instance details

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

toJSON :: PutBackupVaultNotifications -> Value #

toEncoding :: PutBackupVaultNotifications -> Encoding #

toJSONList :: [PutBackupVaultNotifications] -> Value #

toEncodingList :: [PutBackupVaultNotifications] -> Encoding #

ToHeaders PutBackupVaultNotifications Source # 
Instance details

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

toHeaders :: PutBackupVaultNotifications -> [Header] #

ToPath PutBackupVaultNotifications Source # 
Instance details

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

toPath :: PutBackupVaultNotifications -> ByteString #

ToQuery PutBackupVaultNotifications Source # 
Instance details

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

toQuery :: PutBackupVaultNotifications -> QueryString #

AWSRequest PutBackupVaultNotifications Source # 
Instance details

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 Source # 
Instance details

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 Source # 
Instance details

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

readsPrec :: Int -> ReadS PutBackupVaultNotifications #

readList :: ReadS [PutBackupVaultNotifications] #

readPrec :: ReadPrec PutBackupVaultNotifications #

readListPrec :: ReadPrec [PutBackupVaultNotifications] #

Show PutBackupVaultNotifications Source # 
Instance details

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

showsPrec :: Int -> PutBackupVaultNotifications -> ShowS #

show :: PutBackupVaultNotifications -> String #

showList :: [PutBackupVaultNotifications] -> ShowS #

NFData PutBackupVaultNotifications Source # 
Instance details

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

rnf :: PutBackupVaultNotifications -> () #

Eq PutBackupVaultNotifications Source # 
Instance details

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

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

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

Hashable PutBackupVaultNotifications Source # 
Instance details

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

hashWithSalt :: Int -> PutBackupVaultNotifications -> Int #

hash :: PutBackupVaultNotifications -> Int #

type AWSResponse PutBackupVaultNotifications Source # 
Instance details

Defined in Amazonka.Backup.PutBackupVaultNotifications

type AWSResponse PutBackupVaultNotifications = PutBackupVaultNotificationsResponse
type Rep PutBackupVaultNotifications Source # 
Instance details

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 Source #

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 Source #

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 Source #

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] Source #

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 Source #

See: newPutBackupVaultNotificationsResponse smart constructor.

Constructors

PutBackupVaultNotificationsResponse' 

Instances

Instances details
Generic PutBackupVaultNotificationsResponse Source # 
Instance details

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 Source # 
Instance details

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

readsPrec :: Int -> ReadS PutBackupVaultNotificationsResponse #

readList :: ReadS [PutBackupVaultNotificationsResponse] #

readPrec :: ReadPrec PutBackupVaultNotificationsResponse #

readListPrec :: ReadPrec [PutBackupVaultNotificationsResponse] #

Show PutBackupVaultNotificationsResponse Source # 
Instance details

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

showsPrec :: Int -> PutBackupVaultNotificationsResponse -> ShowS #

show :: PutBackupVaultNotificationsResponse -> String #

showList :: [PutBackupVaultNotificationsResponse] -> ShowS #

NFData PutBackupVaultNotificationsResponse Source # 
Instance details

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

rnf :: PutBackupVaultNotificationsResponse -> () #

Eq PutBackupVaultNotificationsResponse Source # 
Instance details

Defined in Amazonka.Backup.PutBackupVaultNotifications

Methods

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

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

type Rep PutBackupVaultNotificationsResponse Source # 
Instance details

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 Source #

Create a value of PutBackupVaultNotificationsResponse with all optional fields omitted.

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