

 Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

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

# DescribeAutoPredictor
<a name="API_DescribeAutoPredictor"></a>

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

**重要**  
Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## リクエストの構文
<a name="API_DescribeAutoPredictor_RequestSyntax"></a>

```
{
   "PredictorArn": "string"
}
```

## リクエストパラメーター
<a name="API_DescribeAutoPredictor_RequestParameters"></a>

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

 ** [PredictorArn](#API_DescribeAutoPredictor_RequestSyntax) **   <a name="forecast-DescribeAutoPredictor-request-PredictorArn"></a>
予測子の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
必須: はい

## レスポンスの構文
<a name="API_DescribeAutoPredictor_ResponseSyntax"></a>

```
{
   "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"
   }
}
```

## レスポンス要素
<a name="API_DescribeAutoPredictor_ResponseElements"></a>

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

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

 ** [CreationTime](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-CreationTime"></a>
CreateAutoPredictor リクエストのタイムスタンプです。  
タイプ: タイムスタンプ

 ** [DataConfig](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-DataConfig"></a>
データセットグループと追加のデータセットのデータ設定。  
型: [DataConfig](API_DataConfig.md) オブジェクト

 ** [DatasetImportJobArns](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-DatasetImportJobArns"></a>
予測子のトレーニングデータをインポートするために使用されるデータセットのインポートジョブの ARN の配列。  
型: 文字列の配列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [EncryptionConfig](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-EncryptionConfig"></a>
Amazon Forecast がキーにアクセスするために引き受けることができる AWS Key Management Service (KMS) キーと AWS Identity and Access Management (IAM) ロール。このオプションのオブジェクトは、[CreateDataset](API_CreateDataset.md) および [CreatePredictor](API_CreatePredictor.md) リクエストで指定できます。  
型: [EncryptionConfig](API_EncryptionConfig.md) オブジェクト

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-EstimatedTimeRemainingInMinutes"></a>
予測子トレーニングジョブが完了するまでの推定残り時間 (分)。  
タイプ: Long

 ** [ExplainabilityInfo](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ExplainabilityInfo"></a>
Predictor Explainability のステータスと ARN を提供します。  
型: [ExplainabilityInfo](API_ExplainabilityInfo.md) オブジェクト

 ** [ForecastDimensions](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastDimensions"></a>
時系列をグループ化するために使用される属性を指定するディメンション (フィールド) 名の配列。  
型: 文字列の配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
長さの制限：最小長 1、最大長は 63 です。  
パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [ForecastFrequency](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastFrequency"></a>
予測内の予測の頻度。  
有効な間隔は、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](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastHorizon"></a>
モデルが予測するタイムステップの数。予測期間は予測長とも呼ばれます。  
タイプ: 整数

 ** [ForecastTypes](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ForecastTypes"></a>
予測子のトレーニング中に使用される予測タイプ。デフォルト値は ["0.1","0.5","0.9"] です。  
型: 文字列の配列  
配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。  
長さの制限: 最小長は 2 です。最大長は 4 です。  
パターン: `(^0?\.\d\d?$|^mean$)` 

 ** [LastModificationTime](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-LastModificationTime"></a>
リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。  
+  `CREATE_PENDING` (`CreationTime`)
+  `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。
+  `CREATE_STOPPING` - 現在のタイムスタンプ。
+  `CREATE_STOPPED` - ジョブが停止した時点。
+  `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。
タイプ: タイムスタンプ

 ** [Message](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-Message"></a>
エラーが発生した場合は、エラーの原因を詳しく説明するメッセージ。  
タイプ: 文字列

 ** [MonitorInfo](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-MonitorInfo"></a>
Amazon リソースネーム (ARN) とステータスを含む [MonitorInfo](API_MonitorInfo.md) オブジェクト。  
型: [MonitorInfo](API_MonitorInfo.md) オブジェクト

 ** [OptimizationMetric](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-OptimizationMetric"></a>
予測子を最適化するために使用される精度メトリクス。  
型: 文字列  
有効な値：`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE`

 ** [PredictorArn](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-PredictorArn"></a>
予測子の Amazon リソースネーム (ARN)  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [PredictorName](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-PredictorName"></a>
予測子の名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [ReferencePredictorSummary](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-ReferencePredictorSummary"></a>
参照予測子の ARN と状態。このパラメータは、再トレーニング済みまたはアップグレード済みの予測子についてのみ有効です。  
型: [ReferencePredictorSummary](API_ReferencePredictorSummary.md) オブジェクト

 ** [Status](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-Status"></a>
予測子のステータス。含まれる状態は次のとおりです。  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
タイプ: 文字列  
長さの制約: 最大長は 256 です。

 ** [TimeAlignmentBoundary](#API_DescribeAutoPredictor_ResponseSyntax) **   <a name="forecast-DescribeAutoPredictor-response-TimeAlignmentBoundary"></a>
Forecast がデータを集計するときに使用する時間境界。  
型: [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) オブジェクト

## エラー
<a name="API_DescribeAutoPredictor_Errors"></a>

 ** InvalidInputException **   
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。  
HTTP ステータスコード: 400

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

## 以下の資料も参照してください。
<a name="API_DescribeAutoPredictor_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeAutoPredictor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeAutoPredictor) 