Glacier / Client / get_vault_notifications

get_vault_notifications#

Glacier.Client.get_vault_notifications(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_vault_notifications(
    vaultName='string'
)
Parameters:

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

    Note: this parameter is set to “-” bydefault if no value is not specified.

  • vaultName (string) –

    [REQUIRED]

    The name of the vault.

Return type:

dict

Returns:

Response Syntax

{
    'vaultNotificationConfig': {
        'SNSTopic': 'string',
        'Events': [
            'string',
        ]
    }
}

Response Structure

  • (dict) –

    Contains the Amazon S3 Glacier response to your request.

    • vaultNotificationConfig (dict) –

      Returns the notification configuration set on the vault.

      • SNSTopic (string) –

        The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).

      • Events (list) –

        A list of one or more events for which Amazon S3 Glacier will send a notification to the specified Amazon SNS topic.

        • (string) –

Exceptions

  • Glacier.Client.exceptions.ResourceNotFoundException

  • Glacier.Client.exceptions.InvalidParameterValueException

  • Glacier.Client.exceptions.MissingParameterValueException

  • Glacier.Client.exceptions.ServiceUnavailableException

Examples

The example retrieves the notification-configuration for the vault named my-vault.

response = client.get_vault_notifications(
    accountId='-',
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'vaultNotificationConfig': {
        'Events': [
            'InventoryRetrievalCompleted',
            'ArchiveRetrievalCompleted',
        ],
        'SNSTopic': 'arn:aws:sns:us-west-2:0123456789012:my-vault',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}