

 **此頁面僅適用於使用 Vaults 和 2012 年原始 REST API 的 Amazon Glacier 服務的現有客戶。**

如果您要尋找封存儲存解決方案，建議您在 Amazon Glacier Instant Retrieval、S3 Glacier Flexible Retrieval 和 S3 Glacier Deep Archive 中使用 Amazon Glacier 儲存類別。 Amazon S3 若要進一步了解這些儲存選項，請參閱 [Amazon Glacier 儲存類別](https://aws.amazon.com/s3/storage-classes/glacier/)。

Amazon Glacier （原始獨立保存庫型服務） 不再接受新客戶。Amazon Glacier 是一項獨立服務，具有自己的 APIs，可將資料存放在保存庫中，並與 Amazon S3 和 Amazon S3 Glacier 儲存類別不同。您現有的資料將在 Amazon Glacier 中無限期保持安全且可存取。不需要遷移。對於低成本、長期的封存儲存， AWS 建議使用 [Amazon S3 Glacier 儲存類別](https://aws.amazon.com/s3/storage-classes/glacier/)，透過 S3 儲存貯體型 APIs、完整 AWS 區域 可用性、降低成本 AWS 和服務整合，提供卓越的客戶體驗。如果您想要增強功能，請考慮使用我們的解決方案指南，將資料從 Amazon S3 Glacier 保存庫傳輸至 Amazon S3 Glacier 儲存類別，以遷移至 Amazon S3 Glacier 儲存類別。 [AWS Amazon Glacier Amazon S3 ](https://aws.amazon.com/solutions/guidance/data-transfer-from-amazon-s3-glacier-vaults-to-amazon-s3/)

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

# 在任務操作中使用的資料類型
<a name="api-data-types"></a>

以下是與 Amazon Glacier 中的任務操作搭配使用的資料類型。

**Topics**
+ [CSVInput](api-CSVInput.md)
+ [CSVOutput](api-CSVOutput.md)
+ [加密](api-Encryption.md)
+ [GlacierJobDescription](api-GlacierJobDescription.md)
+ [授權](api-Grant.md)
+ [承授者](api-Grantee.md)
+ [InputSerialization](api-InputSerialization.md)
+ [InventoryRetrievalJobInput](api-InventoryRetrievalJobInput.md)
+ [jobParameters](api-jobParameters.md)
+ [OutputLocation](api-OutputLocation.md)
+ [OutputSerialization](api-OutputSerialization.md)
+ [S3Location](api-S3Location.md)
+ [SelectParameters](api-SelectParameters.md)

# CSVInput
<a name="api-CSVInput"></a>

包含有關逗號分隔值 (CSV) 檔案的資訊。

## 目錄
<a name="api-CSVInput-contents"></a>

**評論**  
單一字元用於表示當該字元出現在該資料列的開頭時應應該忽略該資料列。  
*類型：*字串  
*必要*：否

**FieldDelimiter**  
單一字元用於在記錄中分隔個別欄位 此字元必須是 32-126 範圍內的 `\n`、`\r` 或 ASCII 字元。預設為逗號 (`,`)。  
*類型：*字串  
*預設*：,  
*必要*：否

**FileHeaderInfo**  
一個值，用於描述如何處理輸入的第一行。  
*類型：*字串  
*有效值*：`Use` \$1 `Ignore` \$1 `None`   
  
*必要*：否

**QuoteCharacter**  
用作逸出字元的單一字元，其中欄位分隔符號是該值的一部分。  
*類型：*字串  
*必要*：否

**QuoteEscapeCharacter**  
單一字元，用於在已逸出的值內逸出引號字元。  
*類型：*字串  
*必要*：否

**RecordDelimiter**  
單一字元用於分隔個別紀錄。  
*類型：*字串  
*必要*：否

## 詳細資訊
<a name="more-info-api-CSVInput"></a>

 
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

# CSVOutput
<a name="api-CSVOutput"></a>

包含有關儲存任務結果的逗號分隔值 (CSV) 格式的資訊。

## 目錄
<a name="api-CSVOutput-contents"></a>

**FieldDelimiter**  
單一字元用於在記錄中分隔個別欄位  
*類型：*字串  
*必要*：否

**QuoteCharacter**  
用作逸出字元的單一字元，其中欄位分隔符號是該值的一部分。  
*類型：*字串  
*必要*：否

**QuoteEscapeCharacter**  
單一字元，用於在已逸出的值內逸出引號字元。  
*類型：*字串  
*必要*：否

**QuoteFields**  
一個值，指示是否應將所有輸出欄位包含在引號內。  
*有效值*：`ALWAYS` \$1 `ASNEEDED`  
*類型：*字串  
*必要*：否

**RecordDelimiter**  
單一字元用於分隔個別紀錄。  
*類型：*字串  
*必要*：否

## 詳細資訊
<a name="more-info-api-CSVOutput"></a>

 
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

# 加密
<a name="api-Encryption"></a>

包含有關用於在 Amazon S3 中儲存工作結果的加密資訊。

## 目錄
<a name="api-Encryption-contents"></a>

**加密**  
將工作結果儲存在 Amazon S3 中時使用的伺服器端加密演算法。預設值是不加密。  
*類型：*字串  
*有效值*：`aws:kms` \$1 `AES256`  
*必要*：否

**KMSContext**  
選用。如果加密類型是 `aws:kms,`，則可以使用此值來指定任務結果的加密內容。  
*類型：*字串  
*必要*：否

**KMSKeyId**  
用於物件加密的 AWS Key Management Service (AWS KMS) 金鑰 ID。  
*類型：*字串  
*必要*：否

## 詳細資訊
<a name="more-info-api-Encryption"></a>

 
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

# GlacierJobDescription
<a name="api-GlacierJobDescription"></a>

包含 Amazon Glacier (Amazon Glacier) 任務的描述。

## 目錄
<a name="api-GlacierJobDescription-contents"></a>

**Action**  
工作類型。它是 `ArchiveRetrieval`、`InventoryRetrieval` 或 `Select`。  
*類型：*字串

**封存**  
針對選擇或封存擷取任務請求的封存 ID。否則，此欄位為 `null`。  
*類型：*字串

**ArchiveSHA256TreeHash**  
用於封存擷取的整個封存的 SHA256 樹狀雜湊。對於庫存擷取作業，此欄位為 `null`。  
*類型：*字串

**ArchiveSizeInBytes**  
對於 `ArchiveRetrieval` 任務，這是請求下載的封存的大小，以位元組為單位。對於 `InventoryRetrieval` 任務，值為 `null`。  
*類型*：數字

**已完成**  
如果任務完成後，則為 `true` 否則為 `false`。  
*類型*：布林值

**CompletionDate**  
任務完成的日期。  
任務請求完成的國際標準時間 (UTC) 的時間。當任務正在進行時，該值為空。  
*類型*：ISO 8601 日期格式的字串表示法，例如，`2013-03-20T17:03:43.221Z`。

**CreationDate**  
任務開始的國際標準時間 (UTC) 日期。  
*類型*：ISO 8601 日期格式的字串表示法，例如，`2013-03-20T17:03:43.221Z`。

**InventoryRetrievalParameters**  
用於各種庫存擷取的輸入參數。  
*類型*：[InventoryRetrievalJobInput](api-InventoryRetrievalJobInput.md)物件

**InventorySizeInBytes**  
對於 `InventoryRetrieval` 任務，這是請求下載的庫存的大小，以位元組為單位。對於 `ArchiveRetrieval` 或 `Select` 任務，值為 `null`。  
*類型*：數字

**JobDescription**  
當您啟動的任務所提供的任務說明。  
*類型：*字串

**JobId**  
在 Amazon Glacier 中識別任務的 ID。  
*類型：*字串

**JobOutputPath**  
包含任務輸出位置。  
*類型：*字串

**OutputLocation**  
 一個物件，其中包含有關儲存選取任務結果和錯誤的位置的資訊。  
*類型*：[OutputLocation](api-OutputLocation.md)物件

**RetrievalByteRange**  
用於封存擷取任務的擷取位元組範圍，格式為「*StartByteValue*-*EndByteValue*。」 如果封存擷取中沒有指定範圍, 則擷取整個封存，*StartByteValue* 等於 0，而 *EndByteValue* 等於封存的大小減去 1。對於庫存擷取作業，此欄位為 `null`。  
*類型：*字串

**SelectParameters**  
一個物件，其中包含有關用於選擇的參數的資訊。  
*類型*：[SelectParameters](api-SelectParameters.md)物件

**SHA256TreeHash**  
所請求的封存範圍的 SHA256 樹狀雜湊值。如果對封存的 [啟動任務 (POST 任務)](api-initiate-job-post.md) 請求指定了樹狀雜湊值的範圍，則此欄位會傳回一個值。如需關於封存範圍擷取的樹狀雜湊值的詳細資訊，請參閱 [下載資料時接收檢查總和](checksum-calculations-range.md)。  
對於擷取整個封存的特定案例，此值與 `ArchiveSHA256TreeHash` 值相同。  
此欄位在以下情況下為 `null`：  
+ 封存擷取任務所指定的範圍不符合樹狀雜湊。
+ 指定與整個封存和任務狀態相等的範圍的封存任務是 `InProgress`。
+ 庫存任務
+ 選取任務。
*類型：*字串

**SNSTopic**  
如果在工作啟動 ([啟動任務 (POST 任務)](api-initiate-job-post.md)) 中設定了通知，則 Amazon Resource Name (ARN) 代表傳送工作完成或失敗的通知的 Amazon SNS 主題。  
*類型：*字串

**StatusCode**  
表示任務狀態的代碼。  
*有效值*：`InProgress` \$1 `Succeeded` \$1 `Failed`  
*類型：*字串

**StatusMessage**  
任務狀態訊息。  
*類型：*字串

**層**  
用於選擇或封存擷取的資料存方案。  
*有效值*：`Expedited` \$1 `Standard` \$1 `Bulk`  
*類型：*字串

**VaultARN**  
該工作是子資源的保存庫 ARN。  
*類型：*字串

## 詳細資訊
<a name="more-info-api-GlacierJobDescription"></a>
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

# 授權
<a name="api-Grant"></a>

包含關於授予的資訊。

## 目錄
<a name="api-Grant-contents"></a>

**承授者**  
承授者  
*類型*：[承授者](api-Grantee.md)物件  
*必要*：否

**許可**  
給予承授者的許可。  
*類型：*字串  
*有效值*：`FULL_CONTROL` \$1 `WRITE` \$1 `WRITE_ACP` \$1 `READ` \$1 `READ_ACP`  
*必要*：否

## 詳細資訊
<a name="more-info-api-Grant"></a>

 
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

# 承授者
<a name="api-Grantee"></a>

包含關於承授者的資訊。

## 目錄
<a name="api-Grantee-contents"></a>

**DisplayName**  
承授者的螢幕名稱。  
*類型：*字串  
*必要*：否

**EmailAddress**  
承授者的電子郵件地址。  
*類型：*字串  
*必要*：否

**ID**  
承授者的正式使用者 ID。  
*類型：*字串  
*必要*：否

**類型**  
承授者的類型。  
*類型：*字串  
*有效值*：`AmazonCustomerByEmail` \$1 `CanonicalUser` \$1 `Group`   
*必要*：否

**URI**  
承授者群組的 URI。  
*類型：*字串  
*必要*：否

## 詳細資訊
<a name="more-info-api-Grantee"></a>

 
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

# InputSerialization
<a name="api-InputSerialization"></a>

描述封存如何序列化。

## 目錄
<a name="api-InputSerialization-contents"></a>

**CSV**  
描述 CSV 編碼物件的序列化的物件。  
*類型*：[CSVInput](api-CSVInput.md)物件  
*必要*：否

## 詳細資訊
<a name="more-info-api-InputSerialization"></a>

 
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

# InventoryRetrievalJobInput
<a name="api-InventoryRetrievalJobInput"></a>

 提供用於指定各種庫存擷取任務的選項。

## 目錄
<a name="api-InventoryRetrievalJobInput-contents"></a>

**EndDate**  
保存庫庫存擷取範圍的結束日期，以 UTC 表示，其中包含在此日期之前建立的封存。  
*有效值*：ISO 8601 日期格式 (`YYYY-MM-DDThh:mm:ssTZD`) 的字串表示法，例如，`2013-03-20T17:03:43Z`。  
*類型*：字串 ISO 8601 日期格式 (`YYYY-MM-DDThh:mm:ssTZD`) 的字串表示法 (以秒為單位)，例如，`2013-03-20T17:03:43Z`。  
*必要*：否

**Format (格式)**  
 保存庫庫存清單的輸出格式，該清單是在啟動工作以擷取保存庫庫存時由 [啟動任務 (POST 任務)](api-initiate-job-post.md) 請求所設定的。  
*有效值*：`CSV` \$1 `JSON`   
*必要*：否  
*類型：*字串

**限制**  
 每個保存庫庫存擷取請求可以傳回的庫存項目的最大上限數。  
*有效值*：大於或等於 1 的整數值。  
*類型：*字串  
*必要*：否

**Marker**  
 一個不透明的字串，表示其繼續分頁的保存庫庫存擷取結果。您可以在新的 `Initiate Job` 請求中使用此標記來取得額外庫存項目。如果沒有其他庫存項目，這個值為空。  
*類型：*字串  
*必要*：否

**StartDate**  
保存庫庫存擷取的日期範圍的開始，以 UTC 表示，其中包含在此日期或之後建立的封存。  
*有效值*：ISO 8601 日期格式 (`YYYY-MM-DDThh:mm:ssTZD`) 的字串表示法，例如，`2013-03-20T17:03:43Z`。  
*類型*：字串 ISO 8601 日期格式 (`YYYY-MM-DDThh:mm:ssTZD`) 的字串表示法 (以秒為單位)，例如，`2013-03-20T17:03:43Z`。  
*必要*：否

## 詳細資訊
<a name="more-info-api-InventoryRetrievalJobInput"></a>
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

# jobParameters
<a name="api-jobParameters"></a>

提供選項來定義工作。

## 目錄
<a name="api-jobParameters-contents"></a>

**封存**  
您想要封存的 ID。如果 `Type` 欄位設定為 `select` 或 `archive-retrieval`，則此欄位是必要的。如果為庫存擷取工作請求指定此欄位，則會發生錯誤。  
*有效值*：必須是您從先前對 Amazon Glacier (Amazon Glacier) 的請求取得的有效封存 ID。  
*類型：*字串  
*必要 *：是，當 `Type` 設定為 `select` 或 `archive-retrieval`。

**描述**  
工作的可選說明。  
* 有效值 *：描述必須小於或等於 1,024 位元組。允許的字元是沒有控制代碼的 7 位元 ASCII，尤其 ASCII 值是 32-126 十進制或 0x20-0x7E 十六進制。  
*類型：*字串  
*必要*：否

**Format (格式)**  
(選用) 輸出格式，用於啟動任務以擷取文件庫清查。如果您啟動庫存工作並未指定 `Format` 欄位，則 JSON 是預設的格式。  
*有效值*：`CSV` \$1 `JSON`   
*類型：*字串  
*必要*：否

**InventoryRetrievalParameters**  
用於各種庫存擷取的輸入參數。  
*類型*：[InventoryRetrievalJobInput](api-InventoryRetrievalJobInput.md)物件  
*必要*：否

**OutputLocation**  
 一個物件，其中包含有關儲存選取工作結果的位置的資訊。  
*類型*：[OutputLocation](api-OutputLocation.md)物件  
* 必要*：是，對於 `select` 工作而言。

**RetrievalByteRange**  
要為 `archive-retrieval` 擷取的位元組範圍，格式為「*StartByteValue*-*EndByteValue*」。如果不指定此欄位，則擷取整個封存。如果指定此欄位，則位元組範圍必須符合 MB (1024\$1 1024)。MB - 符合表示 *StartByteValue* 必須被 1 MB 整除，並且 *EndByteValue* 加上 1 必須可被 1 MB 整除或者是指定為封存位元組大小值減去 1 的封存的結尾。如果 **RetrievalByteRange** 不符合 MB，則此操作將傳回 `400` 回應。  
如果為 `inventory-retrieval` 或 `select` 工作請求指定此欄位，則會發生錯誤。  
*類型：*字串  
*必要*：否

**SelectParameters**  
一個物件，其中包含有關用於選擇的參數的資訊。  
*類型*：[SelectParameters](api-SelectParameters.md)物件  
*必要*：否

**SNSTopic**  
Amazon Glacier 在任務完成且輸出準備好供您下載時傳送通知的 Amazon SNS 主題的 Amazon Resource Name (ARN)。 Amazon Glacier 定的主題將通知發佈到其訂閱伺服器。  
SNS 主題必須存在。如果沒有，Amazon Glacier 不會為您建立。此外，SNS 主題必須具有政策，可讓已建立工作的帳戶將訊息發佈到該主題。如需有關 SNS 主題名稱的詳細資訊，請參閱 [Amazon Simple Notification Service](https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html) *API 參考* 中的 *CreateTopic*。  
*類型：*字串  
*必要*：否

**層**  
用於選擇或封存擷取工作的方案。`Standard` 是使用的預設值。  
*有效值*：`Expedited` \$1 `Standard` \$1 `Bulk`  
*類型：*字串  
*必要*：否 

**類型**  
工作類型。您可以啟動 任務，對存檔執行 select 查詢、擷取存檔或取得文件庫的清查。  
*有效值*：`select` \$1 `archive-retrieval` \$1 `inventory-retrieval`   
*類型：*字串  
*必要*：是

## 詳細資訊
<a name="more-info-api-jobParameters"></a>
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

# OutputLocation
<a name="api-OutputLocation"></a>

 包含關於儲存任務結果和錯誤的位置的資訊。

## 目錄
<a name="api-OutputLocation-contents"></a>

**S3**  
一個物件描述了 Amazon S3 位置以接收還原請求的結果。  
*Type (類型)*：[S3Location](api-S3Location.md)  
*必要*：是

## 詳細資訊
<a name="more-info-api-OutputLocation"></a>
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

# OutputSerialization
<a name="api-OutputSerialization"></a>

描述輸出如何序列化。

## 目錄
<a name="api-OutputSerialization-contents"></a>

**CSV**  
物件，描述逗號分隔值 (CSV) 編碼的查詢結果的序列化。  
*類型*：[CSVOutput](api-CSVOutput.md)物件  
*必要*：否

## 詳細資訊
<a name="more-info-api-OutputSerialization"></a>

 
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

# S3Location
<a name="api-S3Location"></a>

 包含關於在 Amazon S3 中儲存工作結果之位置的資訊。

## 目錄
<a name="api-S3Location-contents"></a>

**AccessControlList**  
控制對儲存結果的存取之授權清單。  
*類型*：[授權](api-Grant.md) 物件陣列  
*必要*：否

**BucketName**  
工作結果儲存所在之 Amazon S3 儲存貯體的名稱。儲存貯體必須與包含輸入封存物件的保存庫位於相同的 AWS 區域。  
*類型：*字串  
*必要*：是

**CannedACL**  
要套用至任務結果的固定存取控制清單 (ACL)  
*類型：*字串  
*有效值*：`private` \$1 `public-read` \$1 `public-read-write` \$1 `aws-exec-read` \$1 `authenticated-read` \$1 `bucket-owner-read` \$1 `bucket-owner-full-control`  
*必要*：否

**加密**  
包含有關用於儲存工作的加密資訊的物件結果將顯示在 Amazon S3 中。  
*類型*：[加密](api-Encryption.md)物件  
*必要*：否

**字首**  
此字首要追加在該請求結果的前面。字首的最大長度為 512 位元組。  
*類型：*字串  
*必要*：是

**StorageClass**  
用於儲存任務結果的任務類別。  
*類型：*字串  
*有效值*：`STANDARD` \$1 `REDUCED_REDUNDANCY` \$1 `STANDARD_IA`  
*必要*：否

**標記**  
套用到任務結果的標籤集。  
*類型*：字串到字串對應  
*必要*：否

**UserMetadata**  
要隨工作結果儲存於 Amazon S3 之中繼資料的對應。  
*類型*：字串到字串對應  
*必要*：否

## 詳細資訊
<a name="more-info-api-S3Location"></a>

 
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

# SelectParameters
<a name="api-SelectParameters"></a>

包含有關用於選擇的參數的資訊。

## 目錄
<a name="api-SelectParameters-contents"></a>

**運算式**  
用於選擇物件的運算式。運算式不得超過 128,000 個字元的配額。  
*類型：*字串  
*必要*：是

**ExpressionType**  
提供的運算式的類型，例如 `SQL`。  
*有效值*：`SQL`  
*類型：*字串  
*必要*：是

**InputSerialization**  
描述在該選擇中的物件的序列化格式。  
*類型*：[InputSerialization](api-InputSerialization.md)物件  
*必要*：否

**OutputSerialization**  
描述如何序列化選擇任務的結果。  
*必要*：否  
*類型*：[OutputSerialization](api-OutputSerialization.md)物件

## 詳細資訊
<a name="more-info-api-SelectParameters"></a>

 
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)