CreateWhatIfForecastExport - Amazon Forecast

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CreateWhatIfForecastExport

CreateWhatIfForecast オペレーションによって作成された予測を Amazon Simple Storage Service (Amazon S3) バケットにエクスポートします。予測ファイル名は、次の規則に一致します。

≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

<ExportTimestamp> コンポーネントは Java SimpleDateFormat (yyyy-MM-ddTHH -mm-ssZ) にあります。

Amazon Forecast が Amazon S3 バケットにアクセスするために引き受けることができる AWS Identity and Access Management (IAM) ロールを含む DataDestination オブジェクトを指定する必要があります。詳細については、「Amazon Forecast のアクセス許可を設定する」を参照してください。

詳細については、「予測の生成」を参照してください。

すべての What-If 予想エクスポートジョブのリストを取得するには、ListWhatIfForecastExports オペレーションを使用します。

注記

Amazon S3 バケットの予測にアクセスする前に、予測エクスポートジョブの StatusACTIVE となっている必要があります。DescribeWhatIfForecastExport オペレーションを使用して、ステータスを取得します。

リクエストの構文

{ "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "WhatIfForecastArns": [ "string" ], "WhatIfForecastExportName": "string" }

リクエストパラメータ

リクエストは以下の JSON 形式のデータを受け入れます。

Destination

予測を保存する場所と、Amazon Forecast がその場所にアクセスするために引き受けることができる AWS Identity and Access Management (IAM) ロール。予測は Amazon S3 バケットにエクスポートする必要があります。

暗号化を使用する場合は、 に AWS Key Management Service (KMS) キーを含めるDestination必要があります。IAM ロールは、Amazon Forecast がキーにアクセスすることを許可する必要があります。

型: DataDestination オブジェクト

必須: はい

Format

エクスポートされたデータの形式は CSV または PARQUETのいずれかです。

型: 文字列

長さの制限: 最大長は 7 です。

Pattern: ^CSV|PARQUET$

必須: いいえ

Tags

What-If 予想に適用するタグのリスト。

タイプ:Tag オブジェクトの配列

配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。

必須: いいえ

WhatIfForecastArns

エクスポートする What-If 予想 Amazon リソースネーム (ARN) のリスト。

タイプ:文字列の配列

配列メンバー:最小数は 1 項目です。最大数は 50 項目です。

長さの制限: 最大長は 300 です。

Pattern: arn:([a-z\d-]+):forecast:.*:.*:.+

必須:はい

WhatIfForecastExportName

エクスポートする What-If 予想の名前。

型: 文字列

長さの制限:最小長は 1 です。最大長は 63 です。

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*

必須:はい

レスポンスの構文

{ "WhatIfForecastExportArn": "string" }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

WhatIfForecastExportArn

What-If 予想の Amazon リソースネーム (ARN)。

型: 文字列

長さの制限: 最大長は 300 です。

パターン:arn:([a-z\d-]+):forecast:.*:.*:.+

エラー

InvalidInputException

無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。

HTTP ステータスコード:400

LimitExceededException

アカウントあたりのリソース数の制限を超えました。

HTTP ステータスコード:400

ResourceAlreadyExistsException

この名前のリソースは既に存在します。別の名前で再試行してください。

HTTP ステータスコード:400

ResourceInUseException

指定されたリソースは使用中です。

HTTP ステータスコード:400

ResourceNotFoundException

その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。

HTTP ステータスコード:400

その他の参照資料

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。