C# Class Amazon.Glacier.Model.SetVaultNotificationsRequest

Container for the parameters to the SetVaultNotifications operation.

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, go to Configuring Vault Notifications in Amazon Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide .

Inheritance: AmazonGlacierRequest
Mostrar archivo Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method Description
SetVaultNotificationsRequest ( ) : System

Empty constructor used to set properties independently even when a simple constructor is available
SetVaultNotificationsRequest ( string vaultName, VaultNotificationConfig vaultNotificationConfig ) : System

Instantiates SetVaultNotificationsRequest with the parameterized properties
SetVaultNotificationsRequest ( string accountId, string vaultName, VaultNotificationConfig vaultNotificationConfig ) : System

Instantiates SetVaultNotificationsRequest with the parameterized properties

Private Methods

Method Description
IsSetAccountId ( ) : bool
IsSetVaultName ( ) : bool
IsSetVaultNotificationConfig ( ) : bool

Method Details

SetVaultNotificationsRequest() public method

Empty constructor used to set properties independently even when a simple constructor is available
public SetVaultNotificationsRequest ( ) : System
return System

SetVaultNotificationsRequest() public method

Instantiates SetVaultNotificationsRequest with the parameterized properties
public SetVaultNotificationsRequest ( string vaultName, VaultNotificationConfig vaultNotificationConfig ) : System
vaultName string The name of the vault.
vaultNotificationConfig VaultNotificationConfig Provides options for specifying notification configuration.
return System

SetVaultNotificationsRequest() public method

Instantiates SetVaultNotificationsRequest with the parameterized properties
public SetVaultNotificationsRequest ( string accountId, string vaultName, VaultNotificationConfig vaultNotificationConfig ) : System
accountId string 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.
vaultName string The name of the vault.
vaultNotificationConfig VaultNotificationConfig Provides options for specifying notification configuration.
return System