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

Amazonka.Glacier.SetVaultNotifications

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 S3 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 S3 Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide.

Synopsis

Creating a Request

data SetVaultNotifications Source #

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

See: newSetVaultNotifications smart constructor.

Constructors

SetVaultNotifications' 

Fields

  • vaultNotificationConfig :: Maybe VaultNotificationConfig

    Provides options for specifying notification configuration.

  • accountId :: Text

    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 S3 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.

  • vaultName :: Text

    The name of the vault.

Instances

Instances details
Eq SetVaultNotifications Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

Read SetVaultNotifications Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

Show SetVaultNotifications Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

Generic SetVaultNotifications Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

Associated Types

type Rep SetVaultNotifications :: Type -> Type #

NFData SetVaultNotifications Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

Methods

rnf :: SetVaultNotifications -> () #

Hashable SetVaultNotifications Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

ToJSON SetVaultNotifications Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

AWSRequest SetVaultNotifications Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

Associated Types

type AWSResponse SetVaultNotifications #

ToHeaders SetVaultNotifications Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

ToPath SetVaultNotifications Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

ToQuery SetVaultNotifications Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

type Rep SetVaultNotifications Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

type Rep SetVaultNotifications = D1 ('MetaData "SetVaultNotifications" "Amazonka.Glacier.SetVaultNotifications" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "SetVaultNotifications'" 'PrefixI 'True) (S1 ('MetaSel ('Just "vaultNotificationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VaultNotificationConfig)) :*: (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "vaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse SetVaultNotifications Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

newSetVaultNotifications Source #

Create a value of SetVaultNotifications 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:

$sel:vaultNotificationConfig:SetVaultNotifications', setVaultNotifications_vaultNotificationConfig - Provides options for specifying notification configuration.

$sel:accountId:SetVaultNotifications', setVaultNotifications_accountId - 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 S3 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.

$sel:vaultName:SetVaultNotifications', setVaultNotifications_vaultName - The name of the vault.

Request Lenses

setVaultNotifications_accountId :: 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 S3 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

data SetVaultNotificationsResponse Source #

See: newSetVaultNotificationsResponse smart constructor.

Instances

Instances details
Eq SetVaultNotificationsResponse Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

Read SetVaultNotificationsResponse Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

Show SetVaultNotificationsResponse Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

Generic SetVaultNotificationsResponse Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

Associated Types

type Rep SetVaultNotificationsResponse :: Type -> Type #

NFData SetVaultNotificationsResponse Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

type Rep SetVaultNotificationsResponse Source # 
Instance details

Defined in Amazonka.Glacier.SetVaultNotifications

type Rep SetVaultNotificationsResponse = D1 ('MetaData "SetVaultNotificationsResponse" "Amazonka.Glacier.SetVaultNotifications" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "SetVaultNotificationsResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSetVaultNotificationsResponse :: SetVaultNotificationsResponse Source #

Create a value of SetVaultNotificationsResponse with all optional fields omitted.

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