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

# ExportJournalToS3


將日期和時間範圍內的日誌內容從總帳匯出至指定的 Amazon Simple Storage Service (Amazon S3) 儲存貯體。日誌匯出任務可以 Amazon Ion 格式的文字或二進位表示形式，或以 *JSON Lines* 文字格式寫入資料物件。

如果具有指定 的總帳`Name`不存在，則 會擲回 `ResourceNotFoundException`。

如果具有指定 的總帳`Name`處於 `CREATING` 狀態，則 會擲回 `ResourcePreconditionNotMetException`。

您可以為每個總帳啟動最多兩個並行日誌匯出請求。超過此限制後，日誌匯出請求會擲回 `LimitExceededException`。

## 請求語法


```
POST /ledgers/name/journal-s3-exports HTTP/1.1
Content-type: application/json

{
   "ExclusiveEndTime": number,
   "InclusiveStartTime": number,
   "OutputFormat": "string",
   "RoleArn": "string",
   "S3ExportConfiguration": { 
      "Bucket": "string",
      "EncryptionConfiguration": { 
         "KmsKeyArn": "string",
         "ObjectEncryptionType": "string"
      },
      "Prefix": "string"
   }
}
```

## URI 請求參數


請求會使用下列 URI 參數。

 ** [name](#API_ExportJournalToS3_RequestSyntax) **   <a name="qldb-ExportJournalToS3-request-uri-Name"></a>
分類帳的名稱。  
長度限制：長度下限為 1。長度上限為 32。  
模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$`  
必要：是

## 請求主體


請求接受採用 JSON 格式的下列資料。

 ** [ExclusiveEndTime](#API_ExportJournalToS3_RequestSyntax) **   <a name="qldb-ExportJournalToS3-request-ExclusiveEndTime"></a>
要匯出之日誌內容範圍的專屬結束日期和時間。  
`ExclusiveEndTime` 必須採用 `ISO 8601` 日期和時間格式，並以國際標準時間 (UTC) 表示。例如：`2019-06-13T21:36:34Z`。  
`ExclusiveEndTime` 必須小於或等於目前的 UTC 日期和時間。  
類型：Timestamp  
必要：是

 ** [InclusiveStartTime](#API_ExportJournalToS3_RequestSyntax) **   <a name="qldb-ExportJournalToS3-request-InclusiveStartTime"></a>
日誌內容匯出範圍的包含開始日期和時間。  
`InclusiveStartTime` 必須採用 `ISO 8601` 日期和時間格式，並以國際標準時間 (UTC) 表示。例如：`2019-06-13T21:36:34Z`。  
`InclusiveStartTime` 必須在 之前`ExclusiveEndTime`。  
如果您提供的 `InclusiveStartTime`早於總帳的 `CreationDateTime`，Amazon QLDB 會將其預設為總帳的 `CreationDateTime`。  
類型：Timestamp  
必要：是

 ** [OutputFormat](#API_ExportJournalToS3_RequestSyntax) **   <a name="qldb-ExportJournalToS3-request-OutputFormat"></a>
匯出日誌資料的輸出格式。日誌匯出任務可以 [Amazon Ion](https://docs.aws.amazon.com/qldb/latest/developerguide/ion.html) 格式的文字或二進位表示形式，或以 [JSON Lines](https://jsonlines.org/) 文字格式寫入資料物件。  
預設：`ION_TEXT`  
在 JSON Lines 格式中，匯出的資料物件中的每個日誌區塊都是由新行分隔的有效 JSON 物件。您可以使用此格式直接整合 JSON 匯出與 Amazon Athena 等分析工具， AWS Glue 因為這些服務可以自動剖析換行分隔 JSON。  
類型：字串  
有效值:`ION_BINARY | ION_TEXT | JSON`   
必要：否

 ** [RoleArn](#API_ExportJournalToS3_RequestSyntax) **   <a name="qldb-ExportJournalToS3-request-RoleArn"></a>
IAM 角色的 Amazon Resource Name (ARN)，授予日誌匯出任務的 QLDB 許可，以執行下列動作：  
+ 將物件寫入 Amazon S3 儲存貯體。
+ （選用） 在 AWS Key Management Service (AWS KMS) 中使用您的客戶受管金鑰，對匯出的資料進行伺服器端加密。
若要在請求日誌匯出時將角色傳遞至 QLDB，您必須具有在 IAM 角色資源上執行 `iam:PassRole`動作的許可。這是所有日誌匯出請求的必要項目。  
類型：字串  
長度限制︰長度下限為 20。長度上限為 1600。  
必要：是

 ** [S3ExportConfiguration](#API_ExportJournalToS3_RequestSyntax) **   <a name="qldb-ExportJournalToS3-request-S3ExportConfiguration"></a>
匯出請求的 Amazon S3 儲存貯體目的地組態設定。  
類型：[S3ExportConfiguration](API_S3ExportConfiguration.md) 物件  
必要：是

## 回應語法


```
HTTP/1.1 200
Content-type: application/json

{
   "ExportId": "string"
}
```

## 回應元素


如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [ExportId](#API_ExportJournalToS3_ResponseSyntax) **   <a name="qldb-ExportJournalToS3-response-ExportId"></a>
QLDB 指派給每個日誌匯出任務的 UUID （以 Base62-encoded的文字表示）。  
若要描述匯出請求並檢查任務的狀態，您可以使用 `ExportId`呼叫 `DescribeJournalS3Export`。  
類型：字串  
長度限制：固定長度為 22。  
模式：`^[A-Za-z-0-9]+$`

## 錯誤


如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** ResourceNotFoundException **   
指定的資源不存在。  
HTTP 狀態碼：404

 ** ResourcePreconditionNotMetException **   
操作失敗，因為未事先滿足條件。  
HTTP 狀態碼：412

## 另請參閱


如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列介面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS 適用於 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/ExportJournalToS3)