com.amazonaws.services.glacier.model

## クラス SetVaultNotificationsRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.glacier.model.SetVaultNotificationsRequest

- すべての実装されたインタフェース:
    java.io.Serializable

      public class SetVaultNotificationsRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  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 .

  関連項目:
    `AmazonGlacier.setVaultNotifications(SetVaultNotificationsRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `SetVaultNotificationsRequest()` Default constructor for a new SetVaultNotificationsRequest object.
    `SetVaultNotificationsRequest(java.lang.String accountId, java.lang.String vaultName, VaultNotificationConfig vaultNotificationConfig)` Constructs a new SetVaultNotificationsRequest object.
    `SetVaultNotificationsRequest(java.lang.String vaultName, VaultNotificationConfig vaultNotificationConfig)` Constructs a new SetVaultNotificationsRequest object.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getAccountId()` The `AccountId` is the AWS Account ID.
    `java.lang.String` | `getVaultName()` The name of the vault.
    `VaultNotificationConfig` | `getVaultNotificationConfig()` Provides options for specifying notification configuration.
    `int` | `hashCode()`
    `void` | `setAccountId(java.lang.String accountId)` The `AccountId` is the AWS Account ID.
    `void` | `setVaultName(java.lang.String vaultName)` The name of the vault.
    `void` | `setVaultNotificationConfig(VaultNotificationConfig vaultNotificationConfig)` Provides options for specifying notification configuration.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `SetVaultNotificationsRequest` | `withAccountId(java.lang.String accountId)` The `AccountId` is the AWS Account ID.
    `SetVaultNotificationsRequest` | `withVaultName(java.lang.String vaultName)` The name of the vault.
    `SetVaultNotificationsRequest` | `withVaultNotificationConfig(VaultNotificationConfig vaultNotificationConfig)` Provides options for specifying notification configuration.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### 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(java.lang.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.
      パラメータ:
        `vaultName` - The name of the vault.
        `vaultNotificationConfig` - Provides options for specifying notification configuration.

    - #### SetVaultNotificationsRequest

          public SetVaultNotificationsRequest(java.lang.String accountId,
                                      java.lang.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.
      パラメータ:
        `accountId` - The `AccountId` is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
        `vaultName` - The name of the vault.
        `vaultNotificationConfig` - Provides options for specifying notification configuration.

  - ### メソッドの詳細

    - #### getAccountId

          public java.lang.String getAccountId()

      The `AccountId` is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
      戻り値:
        The `AccountId` is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

    - #### setAccountId

          public void setAccountId(java.lang.String accountId)

      The `AccountId` is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
      パラメータ:
        `accountId` - The `AccountId` is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

    - #### withAccountId

          public SetVaultNotificationsRequest withAccountId(java.lang.String accountId)

      The `AccountId` is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

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

      パラメータ:
        `accountId` - The `AccountId` is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

    - #### getVaultName

          public java.lang.String getVaultName()

      The name of the vault.
      戻り値:
        The name of the vault.

    - #### setVaultName

          public void setVaultName(java.lang.String vaultName)

      The name of the vault.
      パラメータ:
        `vaultName` - The name of the vault.

    - #### withVaultName

          public SetVaultNotificationsRequest withVaultName(java.lang.String vaultName)

      The name of the vault.

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

      パラメータ:
        `vaultName` - The name of the vault.

    - #### getVaultNotificationConfig

          public VaultNotificationConfig getVaultNotificationConfig()

      Provides options for specifying notification configuration.
      戻り値:
        Provides options for specifying notification configuration.

    - #### setVaultNotificationConfig

          public void setVaultNotificationConfig(VaultNotificationConfig vaultNotificationConfig)

      Provides options for specifying notification configuration.
      パラメータ:
        `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.

      パラメータ:
        `vaultNotificationConfig` - Provides options for specifying notification configuration.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`