You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Glacier::Notification

Inherits:
Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(account_id, vault_name, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

  • #initialize(account_id, vault_name, options = {}) ⇒ Object

    Parameters:

    • account_id (String)
    • vault_name (String)

    Options Hash (options):

    • :client (Client) —

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :account_id (required, String)
    • :vault_name (required, String)
    • :client (Client) —

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#account_id ⇒ String (readonly)

Returns:

  • (String)

#events ⇒ Array<String> (readonly)

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

Returns:

  • (Array<String>) —

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

#sns_topic ⇒ String (readonly)

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

Returns:

  • (String) —

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

#vault_name ⇒ String (readonly)

Returns:

  • (String)

Instance Method Details

#delete ⇒ Struct

This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon S3 Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.

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

Examples:

Request syntax example with placeholder values


notification.delete()

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#set(options = {}) ⇒ Struct

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.

Examples:

Request syntax example with placeholder values


notification.set({
  vault_notification_config: {
    sns_topic: "string",
    events: ["string"],
  },
})

Options Hash (options):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#vault ⇒ Vault

Returns: