jobParameters - 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、進階選用加密功能等功能。

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

jobParameters

提供選項來定義工作。

目錄

封存

您想要封存的 ID。如果 Type 欄位設定為 selectarchive-retrieval,則此欄位是必要的。如果為庫存擷取工作請求指定此欄位,則會發生錯誤。

有效值:必須是從之前向 Amazon S3 Glacier (S3 Glacier) 請求取得的有效封存 ID。

類型:字串

必要 :是,當 Type 設定為 selectarchive-retrieval

描述

工作的可選說明。

有效值 :描述必須小於或等於 1,024 位元組。允許的字元是沒有控制代碼的 7 位元 ASCII,尤其 ASCII 值是 32-126 十進制或 0x20-0x7E 十六進制。

類型:字串

必要:否

Format (格式)

(選用) 輸出格式,用於啟動任務以擷取文件庫清查。如果您啟動庫存工作並未指定 Format 欄位,則 JSON 是預設的格式。

有效值CSV | JSON

類型:字串

必要:否

InventoryRetrievalParameters

用於各種庫存擷取的輸入參數。

類型InventoryRetrievalJobInput物件

必要:否

OutputLocation

一個物件,其中包含有關儲存選取工作結果的位置的資訊。

類型OutputLocation物件

必要:是,對於 select 工作而言。

RetrievalByteRange

要為 archive-retrieval 擷取的位元組範圍,格式為「StartByteValue-EndByteValue」。如果不指定此欄位,則擷取整個封存。如果指定此欄位,則位元組範圍必須符合 MB (1024* 1024)。MB - 符合表示 StartByteValue 必須被 1 MB 整除,並且 EndByteValue 加上 1 必須可被 1 MB 整除或者是指定為封存位元組大小值減去 1 的封存的結尾。如果 RetrievalByteRange 不符合 MB,則此操作將傳回 400 回應。

如果為 inventory-retrievalselect 工作請求指定此欄位,則會發生錯誤。

類型:字串

必要:否

SelectParameters

一個物件,其中包含有關用於選擇的參數的資訊。

類型SelectParameters物件

必要:否

SNSTopic

Amazon SNS 主題的 Amazon Resource Name (ARN),任務完成時,S3 Glacier 會傳送通知,並且輸出可供您下載。定的主題將通知發佈到其訂閱伺服器。

SNS 主題必須存在。如果沒有,S3 Glacier 不會為您建立輸出。此外,SNS 主題必須具有政策,可讓已建立工作的帳戶將訊息發佈到該主題。如需有關 SNS 主題名稱的詳細資訊,請參閱 Amazon Simple Notification Service API 參考 中的 CreateTopic

類型:字串

必要:否

用於選擇或封存擷取工作的方案。Standard 是使用的預設值。

有效值Expedited | Standard | Bulk

類型:字串

必要:否

類型

工作類型。您可以啟動 任務,對存檔執行 select 查詢、擷取存檔或取得文件庫的清查。

有效值select | archive-retrieval | inventory-retrieval

類型:字串

必要:是

詳細資訊