設定文件庫通知組態 (PUT 通知的組態) - Amazon S3 Glacier

此頁面僅適用於使用 Vault 和 REST API 2012 年原始版本的 S3 Glacier 服務的現有客戶。

如果您要尋找封存儲存解決方案,建議您在 Amazon S3、S3 Glacier S3 Instant RetrievalS3 Glacier Flexible Retrieval 和 S3 Glacier Deep Archive 中使用 S3 Glacier 儲存類別。若要進一步了解這些儲存選項,請參閱 Amazon S3 使用者指南 中的使用 S3 Glacier 儲存類別的 S3 Glacier 儲存類別和長期資料儲存Amazon S3 這些儲存類別使用 Amazon S3 API,適用於所有區域,並且可以在 Amazon S3 主控台中管理。它們提供 Storage Cost Analysis、Storage Lens、進階選用加密功能等功能。

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

設定文件庫通知組態 (PUT 通知的組態)

描述

擷取封存和文件庫庫存是 Amazon S3 Glacier (S3 Glacier) 中的非同步操作,您必須先啟動任務並等待任務完成,然後才能下載任務輸出。您可以設定文件庫,以在這些任務完成時,將訊息發佈到 Amazon Simple Notification Service (Amazon SNS) 主題。可以使用此操作在文件庫上設定通知組態。如需更多詳細資訊,請參閱 在 Amazon S3 Glacier 中設定文件庫通知

要設定文件庫通知,傳送 PUT 請求到文件庫的 notification-configuration 子資源。通知組態特定於文件庫;因此,也被稱為文件庫子資源。該請求應包含提供 Amazon Simple Notification Service (Amazon SNS) 主題的 JSON 文件,以及希望 S3 Glacier 向該主題傳送通知的事件。

可以設定文件庫以發佈以下文件庫事件的通知:

  • ArchiveRetrievalCompleted當為封存擷取啟動的任務完成時,會發生此事件 (啟動 Job (POST工作))。完成的工作的狀態可以是 SucceededFailed。傳送至 SNS 主題的通知與從 描述任務 (GET JobID) 傳回的輸出相同。

  • InventoryRetrievalCompleted當為庫存擷取啟動的任務完成時,會發生此事件 (啟動 Job (POST工作))。完成的工作的狀態可以是 SucceededFailed。傳送至 SNS 主題的通知與從 描述任務 (GET JobID) 傳回的輸出相同。

Amazon SNS 主題必須授予對該文件庫的許可,才能將通知發布到該主題。

請求

要在文件庫上設定通知組態,請將 PUT 請求傳送到文件庫的 notification-configuration 子資源的 URI。您可以在請求內文中指定組態。該設定包含 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, ...] }

注意

AccountId 值是擁有該文件庫之帳戶的 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性使用 '-' (連字號),在這種情況下,Amazon S3 會使用與用於簽署請求之憑證關聯的 AWS 帳戶 ID。如果您使用帳號 ID,請勿在 ID 中包含任何連字號 ('-')。

請求參數

此操作不使用請求參數。

請求標頭

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊,請參閱 常見請求標題

請求主體

請求內文中的 JSON 包含以下欄位。

事件

您希望 S3 Glacier 傳送通知之一或多個事件的陣列。

有效值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 通知設定,以便將兩個事件 (ArchiveRetrievalCompletedInventoryRetrievalCompleted) 的通知傳送到 Amazon SNS 主題 arn:aws:sns:us-west-2:012345678901:mytopic

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

另請參閱

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: