GetVaultNotificationsCommand

This operation retrieves the notification-configuration subresource of the specified vault.

For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a 404 Not Found error. For more information about vault notifications, see Configuring Vault Notifications in Amazon S3 Glacier .

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { GlacierClient, GetVaultNotificationsCommand } from "@aws-sdk/client-glacier"; // ES Modules import
// const { GlacierClient, GetVaultNotificationsCommand } = require("@aws-sdk/client-glacier"); // CommonJS import
const client = new GlacierClient(config);
const input = { // GetVaultNotificationsInput
  accountId: "STRING_VALUE", // required
  vaultName: "STRING_VALUE", // required
};
const command = new GetVaultNotificationsCommand(input);
const response = await client.send(command);
// { // GetVaultNotificationsOutput
//   vaultNotificationConfig: { // VaultNotificationConfig
//     SNSTopic: "STRING_VALUE",
//     Events: [ // NotificationEventList
//       "STRING_VALUE",
//     ],
//   },
// };

Example Usage

 Loading code editorLoading code editor

GetVaultNotificationsCommand Input

Parameter
Type
Description
accountId
Required
string | undefined

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
Required
string | undefined

The name of the vault.

GetVaultNotificationsCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
vaultNotificationConfig
VaultNotificationConfig | undefined

Returns the notification configuration set on the vault.

Throws

Name
Fault
Details
InvalidParameterValueException
client

Returned if a parameter of the request is incorrectly specified.

MissingParameterValueException
client

Returned if a required header or parameter is missing from the request.

ResourceNotFoundException
client

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

ServiceUnavailableException
server

Returned if the service cannot complete the request.

GlacierServiceException
Base exception class for all service exceptions from Glacier service.