CreatePredictorBacktestExportJob - Amazon Forecast

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

CreatePredictorBacktestExportJob

CreateAutoPredictor または CreatePredictor オペレーションによって生成されたバックテスト予測および精度メトリクスをエクスポートします。CSV ファイルまたは Parquet ファイルを含む 2 つのフォルダが、指定した S3 バケットにエクスポートされます。

エクスポートファイル名は、次の規則に一致します。

<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv

<ExportTimestamp> コンポーネントは Java にあります SimpleDate 形式 (yyyyyyyyyyyyyyyyyyyyyyyy-

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

注記

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

リクエストの構文

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

リクエストパラメータ

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

Destination

エクスポートジョブの宛先。S3 パス、Amazon Forecast がロケーションにアクセスできるようにする AWS Identity and Access Management (IAM) ロール、および AWS Key Management Service (KMS) キー (オプション) を入力します。

型: DataDestination オブジェクト

必須: はい

Format

エクスポートするデータの形式。デフォルト値は「CSV」です。

Type: 文字列

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

パターン: ^CSV|PARQUET$

必須: いいえ

PredictorArn

エクスポートする予測子の Amazon リソースネーム (ARN)。

Type: 文字列

長さの制約: 最大長は 256 です。

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

必須: はい

PredictorBacktestExportJobName

バックテストエクスポートジョブの名前。

Type: 文字列

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

パターン: ^[a-zA-Z][a-zA-Z0-9_]*

必須: はい

Tags

バックテストの分類と整理に役立つオプションのメタデータ。タグはそれぞれ、1 つのキーとオプションの 1 つの値で設定されており、どちらもお客様側が定義します。タグのキーと値は大文字と小文字が区別されます。

タグには以下の制限があります。

  • タグキーは、リソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。

  • リソースあたりのタグの最大数: 50。

  • キーの最大長: 128 文字 (Unicode)。

  • 値の最大長: 256 文字 (Unicode)。

  • 使用可能な文字: すべての文字と数字、UTF-8 で表現可能なスペース、および + - = 。_ : / @。タグ付けスキーマが他のサービスやリソースで使用されている場合、それらのサービスの文字制限も適用されます。

  • キープレフィックスには、aws: または AWS: の大文字または小文字の組み合わせを含めることはできません。値にはこのプレフィックスを付けることができます。タグ値には aws がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 50 個を計算する際に算入します。aws のキープレフィックスのみを持つタグは、リソース制限あたりのタグに算入されません。このプレフィックスが含まれるタグキーを編集したり削除することはできません。

Type: Array ofTagオブジェクト

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

必須: いいえ

レスポンスの構文

{ "PredictorBacktestExportJobArn": "string" }

レスポンス要素

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

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

PredictorBacktestExportJobArn

エクスポートする予測子バックテストエクスポートジョブの Amazon リソースネーム (ARN)。

Type: 文字列

長さの制約: 最大長は 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 を使用する方法の詳細については、以下を参照してください。