AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
For .NET Core this operation is only available in asynchronous form. Please refer to SetVaultNotificationsAsync.
Namespace: Amazon.Glacier
Assembly: AWSSDK.Glacier.dll
Version: 3.x.y.z
public virtual SetVaultNotificationsResponse SetVaultNotifications( SetVaultNotificationsRequest request )
Container for the necessary parameters to execute the SetVaultNotifications service method.
| Exception | Condition |
|---|---|
| InvalidParameterValueException | Returned if a parameter of the request is incorrectly specified. |
| MissingParameterValueException | Returned if a required header or parameter is missing from the request. |
| ResourceNotFoundException | Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist. |
| ServiceUnavailableException | Returned if the service cannot complete the request. |
The example sets the examplevault notification configuration.
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"
}
});
.NET Framework:
Supported in: 4.5 and newer, 3.5