ボールトの通知設定の指定 (PUT notification-configuration)

説明

Amazon S3 Glacier (S3 Glacier) では、アーカイブおよびボールトインベントリの取得は非同期オペレーションです。そのため、ジョブ出力をダウンロードするには、まずジョブを開始し、ジョブが完了するまで待機する必要があります。そのため、こうしたジョブが完了したときに Amazon Simple Notification Service (Amazon SNS) トピックにメッセージを投稿するようにボールトを設定できます。このオペレーションを使用すると、ボールトに通知設定を指定できます。詳細については、「Amazon S3 Glacier でのボールト通知の設定」を参照してください。

ボールトの通知を設定するには、ボールトの notification-configuration サブリソースに PUT リクエストを送信します。通知設定はボールトに固有です。そのため、ボールトサブリソースとも呼ばれます。リクエストには、Amazon Simple Notification Service (Amazon SNS)トピックと S3 Glacier がトピックに通知を送信するイベントを指定した JSON ドキュメントを含める必要があります。

次のボールトイベントに対して通知を発行するようにボールトを設定できます。

• ArchiveRetrievalCompleted-このイベントは、アーカイブを取得するために開始されたジョブ (ジョブの開始 (POST ジョブ）) が完了したときに発生します。完了したジョブのステータスは、Succeeded または Failed になります。SNS トピックに送信される通知は、ジョブの説明 (GET JobID) から返される出力と同じ出力です。

• InventoryRetrievalCompleted- このイベントは、インベントリを取得するために開始されたジョブ (ジョブの開始 (POST ジョブ）) が完了したときに発生します。完了したジョブのステータスは、Succeeded または Failed になります。SNS トピックに送信される通知は、ジョブの説明 (GET JobID) から返される出力と同じ出力です。

Amazon SNS トピックでは、トピックに通知を発行できるようにボールトにアクセス権限を付与する必要があります。

リクエスト

ボールトに通知設定を指定するには、ボールトの notification-configuration サブリソースの URI に PUT リクエストを送信します。リクエストボディに設定を指定します。設定には、Amazon SNS トピック名と、各トピックへの通知をトリガーするイベントの配列を含めます。

構文

PUT /AccountId/vaults/VaultName/notification-configuration HTTP/1.1
Host: glacier.Region.amazonaws.com
Date: Date
Authorization: SignatureValue
x-amz-glacier-version: 2012-06-01

{
   "SNSTopic": String,
   "Events":[String, ...] 
}

注記

-AccountIdvalueAWS アカウントボールトを所有するアカウントの ID。AWS アカウント ID、または Amazon S3 Glacier がリクエストの署名に使用した認証情報に関連する AWS アカウント ID を使用している場合はオプションで`-`「-」のどちらかを指定できます。アカウント ID を使用する場合は、ID にハイフン ('-') を含めないでください。

リクエストパラメータ

このオペレーションではリクエストパラメータを使用しません。

リクエストヘッダー

この操作では、すべての操作で共通のリクエストヘッダーのみ使用します。共通のリクエストヘッダーの詳細については、「一般的なリクエストヘッダー」を参照してください。

リクエスト本文

リクエストボディの JSON には、次のフィールドが含まれます。

  のイベント

S3 Glacier が通知を送信する 1 つ以上のイベントの配列。

有効な値: ArchiveRetrievalCompleted | InventoryRetrievalCompleted

必須: はい

型: 配列

SNSTopic

Amazon SNS トピック ARN。詳細については、Amazon Simple Notification Service 使用開始 ガイドの「Amazon SNS の使用開始」を参照してください。

必須: はい

タイプ: 文字列

レスポンス

レスポンスでは、通知設定が承認された場合、Amazon S3 Glacier (S3 Glacier) によって 204 No Content が返されます。

構文

HTTP/1.1 204 No Content
x-amzn-RequestId: x-amzn-RequestId
Date: Date

レスポンスヘッダー

この操作では、すべての操作で共通のリクエストヘッダーのみ使用します。共通のリクエストヘッダーの詳細については、「一般的なリクエストヘッダー」を参照してください。

レスポンス本文

このオペレーションでは、レスポンス本文は返しません。

エラー

Amazon S3 Glacier の例外とエラーメッセージについては、「エラーレスポンス」を参照してください。

例

以下の例は、ボールトの通知を設定する方法を示したものです。

リクエストの例

次のリクエストでは、examplevault の通知が設定されるため、2 つのイベント (ArchiveRetrievalCompleted と InventoryRetrievalCompleted) に対する通知が Amazon SNS トピック に送信されます。

PUT /-/vaults/examplevault/notification-policy HTTP/1.1
Host: glacier.us-west-2.amazonaws.com
x-amz-Date: 20170210T120000Z
x-amz-glacier-version: 2012-06-01
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2

{ 
   "Events": ["ArchiveRetrievalCompleted", "InventoryRetrievalCompleted"],
   "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic"       
}

レスポンスの例

正常なレスポンスでは、204 No Content が返されます。

HTTP/1.1 204 No Content
x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
Date: Wed, 10 Feb 2017 12:00:00 GMT

関連するセクション

• ボールト通知の取得 (GET notification-configuration)

• ボールト通知の削除 (通知設定の削除)

• Amazon S3 Glacier の ID とアクセス管理

以下も参照してください。

言語固有の Amazon SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください。

• AWS Command Line Interface