SetVaultNotificationsRequest Class

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Glacier.AmazonGlacierRequest
      Amazon.Glacier.Model.SetVaultNotificationsRequest

Namespace: Amazon.Glacier.Model
Assembly: AWSSDK.Glacier.dll
Version: 3.x.y.z

Syntax

public class SetVaultNotificationsRequest : AmazonGlacierRequest
         IAmazonWebServiceRequest

The SetVaultNotificationsRequest type exposes the following members

Constructors

	Name	Description
	SetVaultNotificationsRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	SetVaultNotificationsRequest(string, VaultNotificationConfig)	Instantiates SetVaultNotificationsRequest with the parameterized properties
	SetVaultNotificationsRequest(string, string, VaultNotificationConfig)	Instantiates SetVaultNotificationsRequest with the parameterized properties

Properties

Name Type Description

Name	Type	Description
AccountId	System.String	Gets and sets the property 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.
VaultName	System.String	Gets and sets the property VaultName. The name of the vault.
VaultNotificationConfig	Amazon.Glacier.Model.VaultNotificationConfig	Gets and sets the property VaultNotificationConfig. Provides options for specifying notification configuration.

AccountId

System.String

Gets and sets the property 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.

VaultName

System.String

Gets and sets the property VaultName.

The name of the vault.

VaultNotificationConfig

Amazon.Glacier.Model.VaultNotificationConfig

Gets and sets the property VaultNotificationConfig.

Provides options for specifying notification configuration.

Examples

The example sets the examplevault notification configuration.

To configure a vault to post a message to an Amazon SNS topic when jobs complete


var client = new AmazonGlacierClient();
var response = client.SetVaultNotifications(new SetVaultNotificationsRequest 
{
    AccountId = "-",
    VaultName = "examplevault",
    VaultNotificationConfig = new VaultNotificationConfig {
        Events = new List<string> {
            "ArchiveRetrievalCompleted",
            "InventoryRetrievalCompleted"
        },
        SNSTopic = "arn:aws:sns:us-west-2:012345678901:mytopic"
    }
});

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5