com.amazonaws.services.glacier.model

Class SetVaultNotificationsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.glacier.model.SetVaultNotificationsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class SetVaultNotificationsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

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 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, go to Configuring Vault Notifications in Amazon Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide .

See Also:

AmazonGlacier.setVaultNotifications(SetVaultNotificationsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SetVaultNotificationsRequest() Default constructor for a new SetVaultNotificationsRequest object.
SetVaultNotificationsRequest(String accountId, String vaultName, VaultNotificationConfig vaultNotificationConfig) Constructs a new SetVaultNotificationsRequest object.
SetVaultNotificationsRequest(String vaultName, VaultNotificationConfig vaultNotificationConfig) Constructs a new SetVaultNotificationsRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
SetVaultNotificationsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAccountId() The AccountId value is the AWS account ID of the account that owns the vault.
String	getVaultName() The name of the vault.
VaultNotificationConfig	getVaultNotificationConfig() Provides options for specifying notification configuration.
int	hashCode()
void	setAccountId(String accountId) The AccountId value is the AWS account ID of the account that owns the vault.
void	setVaultName(String vaultName) The name of the vault.
void	setVaultNotificationConfig(VaultNotificationConfig vaultNotificationConfig) Provides options for specifying notification configuration.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SetVaultNotificationsRequest	withAccountId(String accountId) The AccountId value is the AWS account ID of the account that owns the vault.
SetVaultNotificationsRequest	withVaultName(String vaultName) The name of the vault.
SetVaultNotificationsRequest	withVaultNotificationConfig(VaultNotificationConfig vaultNotificationConfig) Provides options for specifying notification configuration.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetVaultNotificationsRequest

public SetVaultNotificationsRequest()

Default constructor for a new SetVaultNotificationsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

SetVaultNotificationsRequest

public SetVaultNotificationsRequest(String vaultName,
                            VaultNotificationConfig vaultNotificationConfig)

Constructs a new SetVaultNotificationsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

vaultName - The name of the vault.

vaultNotificationConfig - Provides options for specifying notification configuration.

SetVaultNotificationsRequest

public SetVaultNotificationsRequest(String accountId,
                            String vaultName,
                            VaultNotificationConfig vaultNotificationConfig)

Constructs a new SetVaultNotificationsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

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 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 - The name of the vault.

vaultNotificationConfig - Provides options for specifying notification configuration.

Method Detail

getAccountId

public String getAccountId()

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

Returns:

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

setAccountId

public void setAccountId(String 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 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.

Parameters:

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

withAccountId

public SetVaultNotificationsRequest withAccountId(String 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 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getVaultName

public String getVaultName()

The name of the vault.

Returns:

The name of the vault.

setVaultName

public void setVaultName(String vaultName)

The name of the vault.

Parameters:

vaultName - The name of the vault.

withVaultName

public SetVaultNotificationsRequest withVaultName(String vaultName)

The name of the vault.

Returns a reference to this object so that method calls can be chained together.

Parameters:

vaultName - The name of the vault.

Returns:

A reference to this updated object so that method calls can be chained together.

getVaultNotificationConfig

public VaultNotificationConfig getVaultNotificationConfig()

Provides options for specifying notification configuration.

Returns:

Provides options for specifying notification configuration.

setVaultNotificationConfig

public void setVaultNotificationConfig(VaultNotificationConfig vaultNotificationConfig)

Provides options for specifying notification configuration.

Parameters:

vaultNotificationConfig - Provides options for specifying notification configuration.

withVaultNotificationConfig

public SetVaultNotificationsRequest withVaultNotificationConfig(VaultNotificationConfig vaultNotificationConfig)

Provides options for specifying notification configuration.

Returns a reference to this object so that method calls can be chained together.

Parameters:

vaultNotificationConfig - Provides options for specifying notification configuration.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public SetVaultNotificationsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()