本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
CreateForecastExportJob
將CreateForecast操作建立的預測匯出到您的 Amazon Simple Storage Service (Amazon S3) 儲存貯體。預測檔案名稱將符合下列慣例:
<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
其中 < ExportTimestamp > 組件在 Java 中 SimpleDateFormat(年-月-日-毫米-SSZ)。
您必須指定一個DataDestination物件,該物件包含 Amazon Forecast 可以假定存取 Amazon S3 儲存貯體的 AWS Identity and Access Management (IAM) 角色。如需詳細資訊,請參閱 設定 Amazon Forecast 的許可。
如需詳細資訊,請參閱 產生預測。
若要取得所有預測匯出工單的清單,請使用此ListForecastExportJobs作業。
注意
必須先執行預測匯出任務,ACTIVE
才能存取 Amazon S3 儲存貯體中的預測。Status
若要取得狀態,請使用DescribeForecastExportJob作業。
請求語法
{
"Destination": {
"S3Config": {
"KMSKeyArn": "string
",
"Path": "string
",
"RoleArn": "string
"
}
},
"ForecastArn": "string
",
"ForecastExportJobName": "string
",
"Format": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
]
}
請求參數
請求接受採用 JSON 格式的下列資料。
- Destination
-
您想要儲存預測的位置,以及 Amazon 預測可以擔任存取該位置的 AWS Identity and Access Management (IAM) 角色。預測必須匯出至 Amazon S3 儲存貯體。
如果使用加密,則
Destination
必須包含 AWS Key Management Service (KMS) 金鑰。IAM 角色必須允許 Amazon Forecast 權限才能存取金鑰。類型:DataDestination 物件
必要:是
- ForecastArn
-
您要匯出的預測的 Amazon 資源名稱 (ARN)。
類型:字串
長度限制:長度上限為 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
必要:是
- ForecastExportJobName
-
預測匯出工作的名稱。
類型:字串
長度限制:長度下限為 1。長度上限為 63。
模式:
^[a-zA-Z][a-zA-Z0-9_]*
必要:是
- Format
-
導出數據的格式,CSV 或實木複合地板。預設值為 CSV。
類型:字串
長度限制:最大長度為 7。
模式:
^CSV|PARQUET$
必要:否
- Tags
-
套用至預測匯出工作的選擇性中繼資料,可協助您對其進行分類和組織。每個標籤皆包含由您定義的一個金鑰與一個選用值。
以下基本限制適用於標籤:
-
每個資源的最大標籤數量-50。
-
對於每一個資源,每個標籤金鑰必須是唯一的,且每個標籤金鑰只能有一個值。
-
金鑰長度上限-UTF-8 中 128 個萬國碼字元。
-
最大值長度-UTF-8 中 256 個萬國碼字元。
-
如果您的標記結構描述是跨多項服務和資源使用,請記得其他服務可能會有字元使用限制。通常允許的字元包括:可用 UTF-8 表示的英文字母、數字和空格,還有以下字元:+ - = . _ : / @。
-
標籤鍵與值皆區分大小寫。
-
請勿使用
aws:
AWS:
、或任何大寫或小寫的組合,例如索引鍵的前置字元,因為它會保留供 AWS 使用。您無法使用此字首編輯或刪除標籤關鍵字。值可以有這個前綴。如果標籤值aws
作為其前綴,但鍵沒有,則 Forecast 會將其視為使用者標記,並將計入 50 個標籤的限制。只有 key prefix 的標籤aws
不會計入每個資源限制的標籤。
類型:Tag 物件陣列
陣列成員:項目數下限為 0。項目數上限為 200。
必要:否
-
回應語法
{
"ForecastExportJobArn": "string"
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- ForecastExportJobArn
-
匯出任務的 Amazon 資源名稱 (ARN)。
類型:字串
長度限制:長度上限為 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
錯誤
- InvalidInputException
-
我們無法處理要求,因為它包含無效值或超出有效範圍的值。
HTTP 狀態碼:400
- LimitExceededException
-
已超過每個帳號的資源數量限制。
HTTP 狀態碼:400
- ResourceAlreadyExistsException
-
已有具有此名稱的資源。請使用不同的名稱再試一次。
HTTP 狀態碼:400
- ResourceInUseException
-
指定的資源正在使用中。
HTTP 狀態碼:400
- ResourceNotFoundException
-
我們找不到具有該 Amazon 資源名稱(ARN)的資源。請檢查 ARN,然後再試一次。
HTTP 狀態碼:400
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: