amazonka-glacier-1.6.1: Amazon Glacier SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Glacier.SetVaultNotifications

Contents

Description

This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.

To configure vault notifications, send a PUT request to the notification-configuration subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic.

Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:

  • ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive retrieval is completed (InitiateJob ). The status of the completed job can be Succeeded or Failed. The notification sent to the SNS topic is the same output as returned from DescribeJob .
  • InventoryRetrievalCompleted This event occurs when a job that was initiated for an inventory retrieval is completed (InitiateJob ). The status of the completed job can be Succeeded or Failed. The notification sent to the SNS topic is the same output as returned from DescribeJob .

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .

For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide .

Synopsis

Creating a Request

setVaultNotifications Source #

Creates a value of SetVaultNotifications with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • svnVaultNotificationConfig - Provides options for specifying notification configuration.
  • svnAccountId - The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (-) in the ID.
  • svnVaultName - The name of the vault.

data SetVaultNotifications Source #

Provides options to configure notifications that will be sent when specific events happen to a vault.

See: setVaultNotifications smart constructor.

Instances
Eq SetVaultNotifications Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

Data SetVaultNotifications Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetVaultNotifications -> c SetVaultNotifications #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetVaultNotifications #

toConstr :: SetVaultNotifications -> Constr #

dataTypeOf :: SetVaultNotifications -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SetVaultNotifications) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetVaultNotifications) #

gmapT :: (forall b. Data b => b -> b) -> SetVaultNotifications -> SetVaultNotifications #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetVaultNotifications -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetVaultNotifications -> r #

gmapQ :: (forall d. Data d => d -> u) -> SetVaultNotifications -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SetVaultNotifications -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetVaultNotifications -> m SetVaultNotifications #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetVaultNotifications -> m SetVaultNotifications #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetVaultNotifications -> m SetVaultNotifications #

Read SetVaultNotifications Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

Show SetVaultNotifications Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

Generic SetVaultNotifications Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

Associated Types

type Rep SetVaultNotifications :: Type -> Type #

Hashable SetVaultNotifications Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

ToJSON SetVaultNotifications Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

AWSRequest SetVaultNotifications Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

Associated Types

type Rs SetVaultNotifications :: Type #

ToHeaders SetVaultNotifications Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

ToPath SetVaultNotifications Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

ToQuery SetVaultNotifications Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

NFData SetVaultNotifications Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

Methods

rnf :: SetVaultNotifications -> () #

type Rep SetVaultNotifications Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

type Rep SetVaultNotifications = D1 (MetaData "SetVaultNotifications" "Network.AWS.Glacier.SetVaultNotifications" "amazonka-glacier-1.6.1-1jk94OYE8nZKrGhzWrcb8m" False) (C1 (MetaCons "SetVaultNotifications'" PrefixI True) (S1 (MetaSel (Just "_svnVaultNotificationConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VaultNotificationConfig)) :*: (S1 (MetaSel (Just "_svnAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_svnVaultName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs SetVaultNotifications Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

Request Lenses

svnVaultNotificationConfig :: Lens' SetVaultNotifications (Maybe VaultNotificationConfig) Source #

Provides options for specifying notification configuration.

svnAccountId :: Lens' SetVaultNotifications Text Source #

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (-) in the ID.

Destructuring the Response

setVaultNotificationsResponse :: SetVaultNotificationsResponse Source #

Creates a value of SetVaultNotificationsResponse with the minimum fields required to make a request.

data SetVaultNotificationsResponse Source #

See: setVaultNotificationsResponse smart constructor.

Instances
Eq SetVaultNotificationsResponse Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

Data SetVaultNotificationsResponse Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetVaultNotificationsResponse -> c SetVaultNotificationsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetVaultNotificationsResponse #

toConstr :: SetVaultNotificationsResponse -> Constr #

dataTypeOf :: SetVaultNotificationsResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SetVaultNotificationsResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetVaultNotificationsResponse) #

gmapT :: (forall b. Data b => b -> b) -> SetVaultNotificationsResponse -> SetVaultNotificationsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetVaultNotificationsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetVaultNotificationsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> SetVaultNotificationsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SetVaultNotificationsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetVaultNotificationsResponse -> m SetVaultNotificationsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetVaultNotificationsResponse -> m SetVaultNotificationsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetVaultNotificationsResponse -> m SetVaultNotificationsResponse #

Read SetVaultNotificationsResponse Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

Show SetVaultNotificationsResponse Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

Generic SetVaultNotificationsResponse Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

Associated Types

type Rep SetVaultNotificationsResponse :: Type -> Type #

NFData SetVaultNotificationsResponse Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

type Rep SetVaultNotificationsResponse Source # 
Instance details

Defined in Network.AWS.Glacier.SetVaultNotifications

type Rep SetVaultNotificationsResponse = D1 (MetaData "SetVaultNotificationsResponse" "Network.AWS.Glacier.SetVaultNotifications" "amazonka-glacier-1.6.1-1jk94OYE8nZKrGhzWrcb8m" False) (C1 (MetaCons "SetVaultNotificationsResponse'" PrefixI False) (U1 :: Type -> Type))