DescribeAutoPredictor - Amazon Forecast

Amazon Forecast は、新規顧客では利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら

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

DescribeAutoPredictor

CreateAutoPredictor オペレーションを使用して作成された予測子を記述します。

重要

Amazon Forecast は、新規のお客様は利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら

リクエストの構文

{ "PredictorArn": "string" }

リクエストパラメータ

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

PredictorArn

予測子の Amazon リソースネーム (ARN)。

型: 文字列

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

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

必須:はい

レスポンスの構文

{ "CreationTime": number, "DataConfig": { "AdditionalDatasets": [ { "Configuration": { "string" : [ "string" ] }, "Name": "string" } ], "AttributeConfigs": [ { "AttributeName": "string", "Transformations": { "string" : "string" } } ], "DatasetGroupArn": "string" }, "DatasetImportJobArns": [ "string" ], "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "EstimatedTimeRemainingInMinutes": number, "ExplainabilityInfo": { "ExplainabilityArn": "string", "Status": "string" }, "ForecastDimensions": [ "string" ], "ForecastFrequency": "string", "ForecastHorizon": number, "ForecastTypes": [ "string" ], "LastModificationTime": number, "Message": "string", "MonitorInfo": { "MonitorArn": "string", "Status": "string" }, "OptimizationMetric": "string", "PredictorArn": "string", "PredictorName": "string", "ReferencePredictorSummary": { "Arn": "string", "State": "string" }, "Status": "string", "TimeAlignmentBoundary": { "DayOfMonth": number, "DayOfWeek": "string", "Hour": number, "Month": "string" } }

レスポンス要素

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

以下のデータは、 サービスによって JSON 形式で返されます。

CreationTime

CreateAutoPredictor リクエストのタイムスタンプ。

型: タイムスタンプ

DataConfig

データセットグループと追加のデータセットのデータ設定。

型: DataConfig オブジェクト

DatasetImportJobArns

予測子ARNsのトレーニングデータをインポートするために使用されるデータセットインポートジョブの の配列。

型: 文字列の配列

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

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

EncryptionConfig

Amazon Forecast がキーにアクセスするために引き受けることができる AWS Key Management Service (KMS) キーと AWS Identity and Access Management (IAM) ロール。このオプションのオブジェクトは、CreateDataset および CreatePredictor リクエストで指定できます。

型: EncryptionConfig オブジェクト

EstimatedTimeRemainingInMinutes

予測子トレーニングジョブが完了するまでの推定残り時間 (分)。

型: 長整数

ExplainabilityInfo

Predictor Explainability ARN のステータスと を提供します。

型: ExplainabilityInfo オブジェクト

ForecastDimensions

時系列をグループ化するために使用される属性を指定するディメンション (フィールド) 名の配列。

型: 文字列の配列

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

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

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

ForecastFrequency

予測内の予測の頻度。

有効な間隔は、Y (年)、M (月)、W (週)、D (日)、H (時間)、30min (30分)、15min (15分)、10min (10分)、5min (5分)、および 1min (1分) です。例えば、[Y] は毎年を示し、[5min] は 5 分ごとを示します。

型: 文字列

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

パターン: ^Y|M|W|D|H|30min|15min|10min|5min|1min$

ForecastHorizon

モデルが予測するタイムステップの数。予測期間は予測長とも呼ばれます。

型: 整数

ForecastTypes

予測子のトレーニング中に使用される予測タイプ。デフォルト値は ["0.1","0.5","0.9"] です。

型: 文字列の配列

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

長さの制限: 最小長は 2 です。最大長は 4 です。

パターン: (^0?\.\d\d?$|^mean$)

LastModificationTime

リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。

  • CREATE_PENDING (CreationTime)

  • CREATE_IN_PROGRESS - 現在のタイムスタンプ。

  • CREATE_STOPPING - 現在のタイムスタンプ。

  • CREATE_STOPPED - ジョブが停止した時点。

  • ACTIVE または CREATE_FAILED - ジョブが終了または失敗した時点。

型: タイムスタンプ

Message

エラーが発生した場合は、エラーの原因を詳しく説明するメッセージ。

型: 文字列

MonitorInfo

Amazon リソースネーム (ARN) とモニターリソースのステータスを持つMonitorInfoオブジェクト。

型: MonitorInfo オブジェクト

OptimizationMetric

予測子を最適化するために使用される精度メトリクス。

型: 文字列

有効な値: WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE

PredictorArn

予測子の Amazon リソースネーム (ARN)

型: 文字列

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

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

PredictorName

予測子の名前。

型: 文字列

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

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

ReferencePredictorSummary

参照予測子の ARNおよび 状態。このパラメータは、再トレーニング済みまたはアップグレード済みの予測子についてのみ有効です。

型: ReferencePredictorSummary オブジェクト

Status

予測子のステータス。含まれる状態は次のとおりです。

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

型: 文字列

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

TimeAlignmentBoundary

Forecast がデータを集計するときに使用する時間境界。

型: TimeAlignmentBoundary オブジェクト

エラー

InvalidInputException

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

HTTP ステータスコード: 400

ResourceNotFoundException

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

HTTP ステータスコード: 400

以下の資料も参照してください。

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