Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # 操作 Amazon Forecast 服务支持以下操作： + [CreateAutoPredictor](API_CreateAutoPredictor.md) + [CreateDataset](API_CreateDataset.md) + [CreateDatasetGroup](API_CreateDatasetGroup.md) + [CreateDatasetImportJob](API_CreateDatasetImportJob.md) + [CreateExplainability](API_CreateExplainability.md) + [CreateExplainabilityExport](API_CreateExplainabilityExport.md) + [CreateForecast](API_CreateForecast.md) + [CreateForecastExportJob](API_CreateForecastExportJob.md) + [CreateMonitor](API_CreateMonitor.md) + [CreatePredictor](API_CreatePredictor.md) + [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md) + [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) + [CreateWhatIfForecast](API_CreateWhatIfForecast.md) + [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) + [DeleteDataset](API_DeleteDataset.md) + [DeleteDatasetGroup](API_DeleteDatasetGroup.md) + [DeleteDatasetImportJob](API_DeleteDatasetImportJob.md) + [DeleteExplainability](API_DeleteExplainability.md) + [DeleteExplainabilityExport](API_DeleteExplainabilityExport.md) + [DeleteForecast](API_DeleteForecast.md) + [DeleteForecastExportJob](API_DeleteForecastExportJob.md) + [DeleteMonitor](API_DeleteMonitor.md) + [DeletePredictor](API_DeletePredictor.md) + [DeletePredictorBacktestExportJob](API_DeletePredictorBacktestExportJob.md) + [DeleteResourceTree](API_DeleteResourceTree.md) + [DeleteWhatIfAnalysis](API_DeleteWhatIfAnalysis.md) + [DeleteWhatIfForecast](API_DeleteWhatIfForecast.md) + [DeleteWhatIfForecastExport](API_DeleteWhatIfForecastExport.md) + [DescribeAutoPredictor](API_DescribeAutoPredictor.md) + [DescribeDataset](API_DescribeDataset.md) + [DescribeDatasetGroup](API_DescribeDatasetGroup.md) + [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) + [DescribeExplainability](API_DescribeExplainability.md) + [DescribeExplainabilityExport](API_DescribeExplainabilityExport.md) + [DescribeForecast](API_DescribeForecast.md) + [DescribeForecastExportJob](API_DescribeForecastExportJob.md) + [DescribeMonitor](API_DescribeMonitor.md) + [DescribePredictor](API_DescribePredictor.md) + [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md) + [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) + [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) + [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) + [GetAccuracyMetrics](API_GetAccuracyMetrics.md) + [ListDatasetGroups](API_ListDatasetGroups.md) + [ListDatasetImportJobs](API_ListDatasetImportJobs.md) + [ListDatasets](API_ListDatasets.md) + [ListExplainabilities](API_ListExplainabilities.md) + [ListExplainabilityExports](API_ListExplainabilityExports.md) + [ListForecastExportJobs](API_ListForecastExportJobs.md) + [ListForecasts](API_ListForecasts.md) + [ListMonitorEvaluations](API_ListMonitorEvaluations.md) + [ListMonitors](API_ListMonitors.md) + [ListPredictorBacktestExportJobs](API_ListPredictorBacktestExportJobs.md) + [ListPredictors](API_ListPredictors.md) + [ListTagsForResource](API_ListTagsForResource.md) + [ListWhatIfAnalyses](API_ListWhatIfAnalyses.md) + [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md) + [ListWhatIfForecasts](API_ListWhatIfForecasts.md) + [ResumeResource](API_ResumeResource.md) + [StopResource](API_StopResource.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateDatasetGroup](API_UpdateDatasetGroup.md) Amazon Forecast 查询服务支持以下操作： + [QueryForecast](API_forecastquery_QueryForecast.md) + [QueryWhatIfForecast](API_forecastquery_QueryWhatIfForecast.md) # Amazon Forecast 服务 Amazon Forecast 服务支持以下操作： + [CreateAutoPredictor](API_CreateAutoPredictor.md) + [CreateDataset](API_CreateDataset.md) + [CreateDatasetGroup](API_CreateDatasetGroup.md) + [CreateDatasetImportJob](API_CreateDatasetImportJob.md) + [CreateExplainability](API_CreateExplainability.md) + [CreateExplainabilityExport](API_CreateExplainabilityExport.md) + [CreateForecast](API_CreateForecast.md) + [CreateForecastExportJob](API_CreateForecastExportJob.md) + [CreateMonitor](API_CreateMonitor.md) + [CreatePredictor](API_CreatePredictor.md) + [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md) + [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) + [CreateWhatIfForecast](API_CreateWhatIfForecast.md) + [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) + [DeleteDataset](API_DeleteDataset.md) + [DeleteDatasetGroup](API_DeleteDatasetGroup.md) + [DeleteDatasetImportJob](API_DeleteDatasetImportJob.md) + [DeleteExplainability](API_DeleteExplainability.md) + [DeleteExplainabilityExport](API_DeleteExplainabilityExport.md) + [DeleteForecast](API_DeleteForecast.md) + [DeleteForecastExportJob](API_DeleteForecastExportJob.md) + [DeleteMonitor](API_DeleteMonitor.md) + [DeletePredictor](API_DeletePredictor.md) + [DeletePredictorBacktestExportJob](API_DeletePredictorBacktestExportJob.md) + [DeleteResourceTree](API_DeleteResourceTree.md) + [DeleteWhatIfAnalysis](API_DeleteWhatIfAnalysis.md) + [DeleteWhatIfForecast](API_DeleteWhatIfForecast.md) + [DeleteWhatIfForecastExport](API_DeleteWhatIfForecastExport.md) + [DescribeAutoPredictor](API_DescribeAutoPredictor.md) + [DescribeDataset](API_DescribeDataset.md) + [DescribeDatasetGroup](API_DescribeDatasetGroup.md) + [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) + [DescribeExplainability](API_DescribeExplainability.md) + [DescribeExplainabilityExport](API_DescribeExplainabilityExport.md) + [DescribeForecast](API_DescribeForecast.md) + [DescribeForecastExportJob](API_DescribeForecastExportJob.md) + [DescribeMonitor](API_DescribeMonitor.md) + [DescribePredictor](API_DescribePredictor.md) + [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md) + [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) + [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) + [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) + [GetAccuracyMetrics](API_GetAccuracyMetrics.md) + [ListDatasetGroups](API_ListDatasetGroups.md) + [ListDatasetImportJobs](API_ListDatasetImportJobs.md) + [ListDatasets](API_ListDatasets.md) + [ListExplainabilities](API_ListExplainabilities.md) + [ListExplainabilityExports](API_ListExplainabilityExports.md) + [ListForecastExportJobs](API_ListForecastExportJobs.md) + [ListForecasts](API_ListForecasts.md) + [ListMonitorEvaluations](API_ListMonitorEvaluations.md) + [ListMonitors](API_ListMonitors.md) + [ListPredictorBacktestExportJobs](API_ListPredictorBacktestExportJobs.md) + [ListPredictors](API_ListPredictors.md) + [ListTagsForResource](API_ListTagsForResource.md) + [ListWhatIfAnalyses](API_ListWhatIfAnalyses.md) + [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md) + [ListWhatIfForecasts](API_ListWhatIfForecasts.md) + [ResumeResource](API_ResumeResource.md) + [StopResource](API_StopResource.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateDatasetGroup](API_UpdateDatasetGroup.md) # CreateAutoPredictor 创建 Amazon Forecast 预测器。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) Amazon Forecast 使用创建预测变量 AutoPredictor，包括将算法的最佳组合应用于数据集中的每个时间序列。您可以使用 [CreateAutoPredictor](#API_CreateAutoPredictor) 创建新预测器或升级/重新训练现有预测器。 **创建新预测器** 创建新预测器时需要以下参数： + `PredictorName` - 预测器的唯一名称。 + `DatasetGroupArn` - 用于训练预测器的数据集组的 ARN。 + `ForecastFrequency` - 预测的粒度（每小时、每天、每周等）。 + `ForecastHorizon` - 模型预测的时间步长数。预测范围也称为预测长度。创建新预测器时，不要为 `ReferencePredictorArn` 指定值。 **升级和重新训练预测器** 重新训练或升级预测器时需要以下参数： + `PredictorName` - 预测器的唯一名称。 + `ReferencePredictorArn` - 重新训练或升级预测器的 ARN。升级或重新训练预测器时，只能为 `ReferencePredictorArn` 和 `PredictorName` 指定值。 ## 请求语法 ``` { "DataConfig": { "AdditionalDatasets": [ { "Configuration": { "string" : [ "string" ] }, "Name": "string" } ], "AttributeConfigs": [ { "AttributeName": "string", "Transformations": { "string" : "string" } } ], "DatasetGroupArn": "string" }, "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "ExplainPredictor": boolean, "ForecastDimensions": [ "string" ], "ForecastFrequency": "string", "ForecastHorizon": number, "ForecastTypes": [ "string" ], "MonitorConfig": { "MonitorName": "string" }, "OptimizationMetric": "string", "PredictorName": "string", "ReferencePredictorArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TimeAlignmentBoundary": { "DayOfMonth": number, "DayOfWeek": "string", "Hour": number, "Month": "string" } } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [DataConfig](#API_CreateAutoPredictor_RequestSyntax) ** 您的数据集组和任何其他数据集的数据配置。类型：[DataConfig](API_DataConfig.md) 对象必需：否 ** [EncryptionConfig](#API_CreateAutoPredictor_RequestSyntax) ** Amazon Forecast 可以代入的 AWS Key Management Service AWS Identity and Access Management (KMS) 密钥和 (IAM) 角色来访问该密钥。您可以在 [CreateDataset](API_CreateDataset.md) 和 [CreatePredictor](API_CreatePredictor.md) 请求中指定这个可选对象。类型：[EncryptionConfig](API_EncryptionConfig.md) 对象必需：否 ** [ExplainPredictor](#API_CreateAutoPredictor_RequestSyntax) ** 为预测器创建可解释性资源。类型：布尔值必需：否 ** [ForecastDimensions](#API_CreateAutoPredictor_RequestSyntax) ** 维度（字段）名称的数组，用于指定如何对生成的预测进行分组。例如，如果您要生成所有商店的商品销售预测，并且您的数据集包含 `store_id` 字段，则应指定 `store_id` 作为维度来对每家商店的销售预测进行分组。类型：字符串数组数组成员：最少 1 个物品。最多 10 项。长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 必需：否 ** [ForecastFrequency](#API_CreateAutoPredictor_RequestSyntax) ** 预测中的预测频率。有效间隔为一个整数，后跟 Y（年）、M（月）、W（周）、D（日）、H（小时）和 min（分钟）。例如，“1D”表示每天，“15min”表示每 15 分钟。不能指定与下一个较大频率重叠的值。例如，这意味着您不能将频率指定为 60 分钟，因为这相当于 1 小时。每个频率的有效值如下所示： + 分钟 - 1-59 + 小时 - 1-23 + 天 - 1-6 + 周 - 1-4 + 月 - 1-11 + 年 - 1 因此，如果您想要每隔一周进行一次预测，请指定“2W”。或者，如果您想要每季度预测一次，请指定“3M”。该频率必须大于或等于 TARGET\$1TIME\$1SERIES 数据集频率。提供 RELATED\$1TIME\$1SERIES 数据集时，频率必须等于 RELATED\$1TIME\$1SERIES 数据集频率。类型：字符串长度限制：最小长度为 1。最大长度为 5。模式：`^Y|M|W|D|H|30min|15min|10min|5min|1min$` 必需：否 ** [ForecastHorizon](#API_CreateAutoPredictor_RequestSyntax) ** 模型预测的时间步长数。预测范围也称为预测长度。最大预测范围是 500 个时间步长或 TARGET\$1TIME\$1SERIES 数据集长度的 1/4 中较小的一个。如果您要重新训练现有的 AutoPredictor，则最大预测范围为 500 个时间步长或 TARGET\$1TIME\$1SERIES 数据集长度的 1/3 中较小者。如果您要升级到现有版本 AutoPredictor 或对其进行重新培训 AutoPredictor，则无法更新预测展望期参数。您可以通过在数据集中提供更长的时间序列来满足此要求。类型：整数必需：否 ** [ForecastTypes](#API_CreateAutoPredictor_RequestSyntax) ** 用于训练预测器的预测类型。您最多可指定五种预测类型。预测类型可以是从 0.01 到 0.99 的分位数，增量为 0.01 或更高。您也可以使用 `mean` 指定均值预测。类型：字符串数组数组成员：最少 1 项。最多 20 项。长度限制：最小长度为 2。最大长度为 4。模式：`(^0?\.\d\d?$|^mean$)` 必需：否 ** [MonitorConfig](#API_CreateAutoPredictor_RequestSyntax) ** 预测器监控的配置详细信息。提供监控器资源的名称以启用预测器监控。预测器监控允许您查看预测器的性能如何随时间变化。有关更多信息，请参阅[预测器监控](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html)。类型：[MonitorConfig](API_MonitorConfig.md) 对象必需：否 ** [OptimizationMetric](#API_CreateAutoPredictor_RequestSyntax) ** 用于优化预测器的准确性指标。类型：字符串有效值：`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 必需：否 ** [PredictorName](#API_CreateAutoPredictor_RequestSyntax) ** 预测器的唯一名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 是否必需：是 ** [ReferencePredictorArn](#API_CreateAutoPredictor_RequestSyntax) ** 重新训练或升级预测器的 ARN。此参数仅在重新训练或升级预测器时使用。创建新预测器时，不要为此参数指定值。升级或重新训练预测器时，只能为 `ReferencePredictorArn` 和 `PredictorName` 指定值。`PredictorName` 值必须是唯一的预测器名称。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：否 ** [Tags](#API_CreateAutoPredictor_RequestSyntax) ** 可帮助您对预测器进行分类和组织的可选元数据。每个标签都包含定义的一个键和一个可选值。标签键和值区分大小写。以下限制适用于标签： + 对于每个资源，每个标签键都必须是唯一的，每个标签键必须有一个值。 + 每个资源的标签数上限： 50。 + 最大键长度：128 个 Unicode 字符（采用 UTF-8 格式） + 最大值长度：256 个 Unicode 字符（采用 UTF-8 格式） + 可接受的字符：所有字母和数字、可用 UTF-8 表示的空格以及 \$1 - =。\$1 : / @。如果您的标记架构在其他服务和资源中使用，则这些服务的字符限制也适用。 + 键前缀不能包含 `aws:` 或 `AWS:` 的任何大写或小写组合。值可以带有该前缀。如果标签值将 `aws` 作为其前缀，但键没有前缀，则 Forecast 会将其视为用户标签，并将计入 50 个标签的限制。仅具有 `aws` 的键前缀的标签不计入每个资源的标签数限制。不能编辑或删除带该前缀的标签键。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ** [TimeAlignmentBoundary](#API_CreateAutoPredictor_RequestSyntax) ** Forecast 使用时间边界来对齐并汇总任何与您的预测频率不一致的数据。提供时间单位和时间边界作为键值对。有关指定时间边界的更多信息，请参阅[指定时间边界](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary)。如果您未提供时间边界，Forecast 将使用一组[默认时间边界](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries)。类型：[TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) 对象必需：否 ## 响应语法 ``` { "PredictorArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [PredictorArn](#API_CreateAutoPredictor_ResponseSyntax) ** 预测器的 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateAutoPredictor) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateAutoPredictor) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateAutoPredictor) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateAutoPredictor) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateAutoPredictor) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateAutoPredictor) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateAutoPredictor) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateAutoPredictor) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateAutoPredictor) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateAutoPredictor) # CreateDataset 创建 Amazon Forecast 数据集。 **重要** Amazon Forecast 已不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 您提供的有关数据集的信息可帮助 Forecast 了解如何使用数据进行模型训练。这包括以下这些： + * `DataFrequency` * - 收集历史时间序列数据的频率。 + * `Domain` * 和 * `DatasetType` * - 每个数据集都有一个关联的数据集域和域内的类型。Amazon Forecast 提供预定义域和每个域中类型的列表。对于每个唯一的数据集域及域内的类型，Amazon Forecast 要求您的数据包含最小的预定义字段集。 + * `Schema` * - 架构指定数据集中的字段，包括字段名称和数据类型。在创建数据集后，将您的训练数据导入其中并将数据集添加到数据集组。您使用数据集组来创建预测器。有关更多信息，请参阅[导入数据集](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html)。要获取所有数据集的列表，请使用[ListDatasets](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html)操作。有关预测数据集的示例，请参阅 [Amazon Forecas GitHub t 示例存储库](https://github.com/aws-samples/amazon-forecast-samples)。 **注意** 在可以导入训练数据之前，数据集的 `Status` 必须为 `ACTIVE`。使用 [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) 操作获取此状态。 ## 请求语法 ``` { "DataFrequency": "string", "DatasetName": "string", "DatasetType": "string", "Domain": "string", "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [DataFrequency](#API_CreateDataset_RequestSyntax) ** 数据收集的频率。此参数对于 RELATED\$1TIME\$1SERIES 数据集为必需。有效间隔为一个整数，后跟 Y（年）、M（月）、W（周）、D（日）、H（小时）和 min（分钟）。例如，“1D”表示每天，“15min”表示每 15 分钟。不能指定与下一个较大频率重叠的值。例如，这意味着您不能将频率指定为 60 分钟，因为这相当于 1 小时。每个频率的有效值如下所示： + 分钟 - 1-59 + 小时 - 1-23 + 天 - 1-6 + 周 - 1-4 + 月 - 1-11 + 年 - 1 因此，如果您想要每隔一周进行一次预测，请指定“2W”。或者，如果您想要每季度预测一次，请指定“3M”。类型：字符串长度限制：最小长度为 1。最大长度为 5。模式：`^Y|M|W|D|H|30min|15min|10min|5min|1min$` 必需：否 ** [DatasetName](#API_CreateDataset_RequestSyntax) ** 数据集的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 是否必需：是 ** [DatasetType](#API_CreateDataset_RequestSyntax) ** 数据集类型。有效值取决于选定的 `Domain`。类型：字符串有效值：`TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA` 是否必需：是 ** [Domain](#API_CreateDataset_RequestSyntax) ** 与数据集关联的域。将数据集添加到数据集组时，此值和为[CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)操作`Domain`参数指定的值必须匹配。您选择的 `Domain` 和 `DatasetType` 决定导入到数据集的训练数据中必须存在的字段。例如，如果您选择 `RETAIL` 域和 `TARGET_TIME_SERIES` 作为 `DatasetType`，Amazon Forecast 要求数据中存在 `item_id`、`timestamp` 和 `demand` 字段。有关更多信息，请参阅[导入数据集](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html)。类型：字符串有效值：`RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` 是否必需：是 ** [EncryptionConfig](#API_CreateDataset_RequestSyntax) ** 一个 AWS Key Management Service (KMS) 密钥和 AWS Identity and Access Management (IAM) 角色，Amazon Forecast 可以代入该密钥访问该密钥。类型：[EncryptionConfig](API_EncryptionConfig.md) 对象必需：否 ** [Schema](#API_CreateDataset_RequestSyntax) ** 数据集的架构。架构属性及其顺序必须与数据中的字段匹配。您选择的数据集 `Domain` 和 `DatasetType` 可确定训练数据所需的最少字段。有关特定数据集域和类型所需字段的信息，请参阅[数据集域和数据集类型](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html)。类型：[Schema](API_Schema.md) 对象是否必需：是 ** [Tags](#API_CreateDataset_RequestSyntax) ** 您应用于数据集以帮助您对其进行分类和组织的可选元数据。每个标签都包含定义的一个键和一个可选值。下面是适用于标签的基本限制： + 每个资源的最大标签数 - 50。 + 对于每个资源，每个标签键必须是唯一的，并且每个标签键只能有一个值。 + 最大键长度 - 128 个 Unicode 字符（采用 UTF-8 格式）。 + 最大值长度 - 256 个 Unicode 字符（采用 UTF-8 格式）。 + 如果您的标记模式针对多个服务和资源使用，请记得其它服务可能对允许使用的字符有限制。通常允许使用的字符包括：可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：\$1：= . \$1 : / @。 + 标签键和值区分大小写。 + 请勿使用`aws:``AWS:`、或任何大写或小写组合，例如密钥的前缀，因为它是保留供 AWS 使用的。不能编辑或删除带此前缀的标签键。值可以带有该前缀。如果标签值将 `aws` 作为其前缀，但键没有前缀，则 Forecast 会将其视为用户标签，并将计入 50 个标签的限制。仅具有 `aws` 的键前缀的标签不计入每个资源的标签数限制。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "DatasetArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [DatasetArn](#API_CreateDataset_ResponseSyntax) ** 数据集的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** LimitExceededException ** 超过了每个账户的资源数量限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 已存在同名资源。请使用不同的名称重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateDataset) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDataset) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDataset) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDataset) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDataset) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDataset) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDataset) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDataset) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDataset) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDataset) # CreateDatasetGroup 创建一个数据集组，其中包含相关数据集的集合。您可以在创建数据集组时将数据集添加到数据集组，也可以稍后使用[UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)操作将数据集添加到数据集组。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 在创建数据集组并添加数据集后，您可在创建预测器时使用该数据集组。有关更多信息，请参阅[数据集组](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html)。要获取所有数据集组的列表，请使用[ListDatasetGroups](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html)操作。 **注意** 数据集组的 `Status` 必须为 `ACTIVE`，然后才能使用数据集组创建预测器。使用 [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) 操作获取状态。 ## 请求语法 ``` { "DatasetArns": [ "string" ], "DatasetGroupName": "string", "Domain": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [DatasetArns](#API_CreateDatasetGroup_RequestSyntax) ** 您要包含在数据集组中的数据集的 Amazon 资源名称 (ARNs) 数组。类型：字符串数组长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：否 ** [DatasetGroupName](#API_CreateDatasetGroup_RequestSyntax) ** 数据集组的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 是否必需：是 ** [Domain](#API_CreateDatasetGroup_RequestSyntax) ** 与数据集组关联的域。将数据集添加到数据集组时，此值和为[CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)操作`Domain`参数指定的值必须匹配。您选择的 `Domain` 和 `DatasetType` 决定导入到数据集的训练数据中必须存在的字段。例如，如果您选择 `RETAIL` 域和 `TARGET_TIME_SERIES` 作为 `DatasetType`，Amazon Forecast 要求数据中存在 `item_id`、`timestamp` 和 `demand` 字段。有关更多信息，请参阅[数据集组](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html)。类型：字符串有效值：`RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` 是否必需：是 ** [Tags](#API_CreateDatasetGroup_RequestSyntax) ** 您应用于数据集组以帮助您对其进行分类和组织的可选元数据。每个标签都包含定义的一个键和一个可选值。下面是适用于标签的基本限制： + 每个资源的最大标签数 - 50。 + 对于每个资源，每个标签键必须是唯一的，并且每个标签键只能有一个值。 + 最大键长度 - 128 个 Unicode 字符（采用 UTF-8 格式）。 + 最大值长度 - 256 个 Unicode 字符（采用 UTF-8 格式）。 + 如果您的标记模式针对多个服务和资源使用，请记得其它服务可能对允许使用的字符有限制。通常允许使用的字符包括：可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：\$1：= . \$1 : / @。 + 标签键和值区分大小写。 + 请勿使用`aws:``AWS:`、或任何大写或小写组合，例如密钥的前缀，因为它是保留供 AWS 使用的。不能编辑或删除带此前缀的标签键。值可以带有该前缀。如果标签值将 `aws` 作为其前缀，但键没有前缀，则 Forecast 会将其视为用户标签，并将计入 50 个标签的限制。仅具有 `aws` 的键前缀的标签不计入每个资源的标签数限制。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "DatasetGroupArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [DatasetGroupArn](#API_CreateDatasetGroup_ResponseSyntax) ** 数据集组的 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateDatasetGroup) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDatasetGroup) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDatasetGroup) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDatasetGroup) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDatasetGroup) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDatasetGroup) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDatasetGroup) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDatasetGroup) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDatasetGroup) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDatasetGroup) # CreateDatasetImportJob 将训练数据导入 Amazon Forecast 数据集。您应提供训练数据在 Amazon Simple Storage Service（Amazon S3）存储桶中的位置以及要将数据导入到的数据集的 Amazon 资源名称（ARN）。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 您必须指定一个包含一个 AWS Identity and Access Management (IAM) 角色的[DataSource](https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html)对象，Amazon Forecast 可以代入该角色来访问数据，因为 Amazon Forecast 会生成您的数据副本并在内部 AWS 系统中对其进行处理。有关更多信息，请参阅[设置权限](https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html)。训练数据必须采用 CSV 或 Parquet 格式。分隔符必须是逗号 (,)。您可以指定特定文件、S3 存储桶或 S3 存储桶中的文件夹的路径。对于后两种情况，Amazon Forecast 会导入所有文件，上限为 10,000 个文件。由于未聚合数据集导入，因此最近的数据集导入是在训练预测器或生成预测时使用的数据集导入。确保最近的数据集导入中包含您在建模时希望使用的所有数据，而不仅仅是自上次导入以来收集的新数据。要获取按指定条件筛选的所有数据集导入任务的列表，请使用[ListDatasetImportJobs](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html)操作。 ## 请求语法 ``` { "DatasetArn": "string", "DatasetImportJobName": "string", "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "GeolocationFormat": "string", "ImportMode": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TimestampFormat": "string", "TimeZone": "string", "UseGeolocationForTimeZone": boolean } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [DatasetArn](#API_CreateDatasetImportJob_RequestSyntax) ** 您要将数据导入到的 Amazon Forecast 数据集的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [DatasetImportJobName](#API_CreateDatasetImportJob_RequestSyntax) ** 数据集导入作业的名称。我们建议在名称中包含当前时间戳，例如 `20190721DatasetImport`。这可以帮助您避免出现 `ResourceAlreadyExistsException` 异常。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 是否必需：是 ** [DataSource](#API_CreateDatasetImportJob_RequestSyntax) ** 要导入的训练数据的位置以及 Amazon Forecast 可以担任的访问数据的 AWS Identity and Access Management (IAM) 角色。训练数据必须存储在 Amazon S3 存储桶中。如果使用加密，则`DataSource`必须包含 AWS Key Management Service (KMS) 密钥，IAM 角色必须允许 Amazon Forecast 访问该密钥。KMS 密钥和 IAM 角色必须与[CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)操作`EncryptionConfig`参数中指定的密钥和 IAM 角色相匹配。类型：[DataSource](API_DataSource.md) 对象是否必需：是 ** [Format](#API_CreateDatasetImportJob_RequestSyntax) ** 导入数据的格式，CSV 或 PARQUET。默认值为 CSV。类型：字符串长度限制：最大长度为 7。模式：`^CSV|PARQUET$` 必需：否 ** [GeolocationFormat](#API_CreateDatasetImportJob_RequestSyntax) ** 地理位置属性的格式。地理位置属性可以采用以下两种方式之一进行格式化： + `LAT_LONG` - 以十进制格式表示的纬度和经度（示例：47.61\$1-122.33）。 + `CC_POSTALCODE`（仅限美国）- 国家/地区代码（US），后面是 5 位数的邮政编码（示例：US\$198121）。类型：字符串长度约束：最大长度为 256。模式：`^[a-zA-Z0-9_]+$` 必需：否 ** [ImportMode](#API_CreateDatasetImportJob_RequestSyntax) ** 指定数据集导入作业是 `FULL` 还是 `INCREMENTAL` 导入。`FULL` 数据集导入会将所有现有数据替换为新导入的数据。`INCREMENTAL` 导入会将导入的数据附加到现有数据中。类型：字符串有效值：`FULL | INCREMENTAL` 必需：否 ** [Tags](#API_CreateDatasetImportJob_RequestSyntax) ** 您应用于数据集导入作业以帮助您对其进行分类和组织的可选元数据。每个标签都包含定义的一个键和一个可选值。下面是适用于标签的基本限制： + 每个资源的最大标签数 - 50。 + 对于每个资源，每个标签键必须是唯一的，并且每个标签键只能有一个值。 + 最大键长度 - 128 个 Unicode 字符（采用 UTF-8 格式）。 + 最大值长度 - 256 个 Unicode 字符（采用 UTF-8 格式）。 + 如果您的标记模式针对多个服务和资源使用，请记得其它服务可能对允许使用的字符有限制。通常允许使用的字符包括：可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：\$1：= . \$1 : / @。 + 标签键和值区分大小写。 + 请勿使用`aws:``AWS:`、或任何大写或小写组合，例如密钥的前缀，因为它是保留供 AWS 使用的。不能编辑或删除带此前缀的标签键。值可以带有该前缀。如果标签值将 `aws` 作为其前缀，但键没有前缀，则 Forecast 会将其视为用户标签，并将计入 50 个标签的限制。仅具有 `aws` 的键前缀的标签不计入每个资源的标签数限制。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ** [TimestampFormat](#API_CreateDatasetImportJob_RequestSyntax) ** 数据集中时间戳的格式。您指定的格式取决于创建数据集时 `DataFrequency` 指定的格式。支持以下格式。 + “yyyy-MM-dd” 适用于以下数据频率：Y、M、W 和 D + “yyyy-MM-dd HH: mm: ss” 适用于以下数据频率：H、30min、15min 和 1min；也可选择用于：Y、M、W 和 D 如果未指定格式，Amazon Forecast 预计格式为“yyyy-MM-dd HH:mm:ss”。类型：字符串长度约束：最大长度为 256。模式：`^[a-zA-Z0-9\-\:\.\,\'\s]+$` 必需：否 ** [TimeZone](#API_CreateDatasetImportJob_RequestSyntax) ** 数据集中每个项目的单个时区。此选项非常适合所有时间戳都在单个时区内的数据集，或者所有时间戳都标准化为单个时区的数据集。有关有效时区名称的完整列表，请参阅 [Joda-Time API](http://joda-time.sourceforge.net/timezones.html)。类型：字符串长度约束：最大长度为 256。模式：`^[a-zA-Z0-9\/\+\-\_]+$` 必需：否 ** [UseGeolocationForTimeZone](#API_CreateDatasetImportJob_RequestSyntax) ** 自动从地理位置属性中获取时区信息。此选项非常适合包含多个时区的时间戳且这些时间戳以当地时间表示的数据集。类型：布尔值必需：否 ## 响应语法 ``` { "DatasetImportJobArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [DatasetImportJobArn](#API_CreateDatasetImportJob_ResponseSyntax) ** 数据集导入作业的 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateDatasetImportJob) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDatasetImportJob) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDatasetImportJob) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDatasetImportJob) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDatasetImportJob) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDatasetImportJob) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDatasetImportJob) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDatasetImportJob) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDatasetImportJob) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDatasetImportJob) # CreateExplainability **注意** 可解释性仅适用于从 () 生成的预测和预测变量 AutoPredictor [CreateAutoPredictor](API_CreateAutoPredictor.md) 创建 Amazon Forecast 可解释性。 **重要** Amazon Forecast 已不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 可解释性可帮助您更好地了解数据集中的属性如何影响预测。Amazon Forecast 使用名为影响力分数的指标来量化每个属性的相对影响，并确定它们是增加还是减少预测值。要启用预测可解释性，您的预测器必须至少包含以下其中一项：相关时间序列、项目元数据或其他数据集，例如节假日和天气指数。 **注意** ARIMA（AutoRegressive 综合移动平均线）、ETS（指数平滑状态空间模型）和 NPTS（非参数时间序列）模型不包含外部时间序列数据。因此，即使您包含了其他数据集，这些模型也不会创建可解释性报告。 CreateExplainability 接受预测变量 ARN 或 Forecast ARN。要接收数据集中所有时间序列和时间点的汇总影响力分数，请提供预测器 ARN。要接收特定时间序列和时间点的影响力分数，请提供预测 ARN。 **CreateExplainability 使用预测变量 ARN** **注意** 每个预测器只能有一个可解释性资源。如果您已在 [CreateAutoPredictor](API_CreateAutoPredictor.md) 中启用 `ExplainPredictor`，则该预测器已经具有可解释性资源。提供预测器 ARN 时，以下参数为必需参数： + `ExplainabilityName` - 可解释性的唯一名称。 + `ResourceArn` - 预测器的 Arn。 + `TimePointGranularity` - 必须设置为“全部”。 + `TimeSeriesGranularity` - 必须设置为“全部”。以下参数不需要指定值： + `DataSource`-仅在 “具体” 时 TimeSeriesGranularity 有效。 + `Schema`-仅在 “具体” 时 TimeSeriesGranularity 有效。 + `StartDateTime`-仅在 “具体” 时 TimePointGranularity 有效。 + `EndDateTime`-仅在 “具体” 时 TimePointGranularity 有效。 **CreateExplainability 使用 Forecast ARN** **注意** 您最多可以指定 50 个时间序列和 500 个时间点。提供预测器 ARN 时，以下参数为必需参数： + `ExplainabilityName` - 可解释性的唯一名称。 + `ResourceArn` - 预测的 Arn。 + `TimePointGranularity` -“全部”或“特定”。 + `TimeSeriesGranularity` -“全部”或“特定”。如果您设置 TimeSeriesGranularity 为 “具体”，则还必须提供以下信息： + `DataSource` - 指定您的时间序列的 CSV 文件的 S3 位置。 + `Schema` - 架构定义了数据来源中列出的属性和属性类型。如果您设置 TimePointGranularity 为 “具体”，则还必须提供以下信息： + `StartDateTime` - 时间点范围内的第一个时间戳。 + `EndDateTime` - 时间点范围内的最后一个时间戳。 ## 请求语法 ``` { "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "EnableVisualization": boolean, "EndDateTime": "string", "ExplainabilityConfig": { "TimePointGranularity": "string", "TimeSeriesGranularity": "string" }, "ExplainabilityName": "string", "ResourceArn": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "StartDateTime": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [DataSource](#API_CreateExplainability_RequestSyntax) ** 您的数据来源、允许 Amazon Forecast 访问数据的 AWS Identity and Access Management (IAM) 角色以及可选的 AWS Key Management Service (KMS) 密钥。类型：[DataSource](API_DataSource.md) 对象必需：否 ** [EnableVisualization](#API_CreateExplainability_RequestSyntax) ** 创建可在控制台中查看的可解释性可视化。 AWS 类型：布尔值必需：否 ** [EndDateTime](#API_CreateExplainability_RequestSyntax) ** 如果设置 `TimePointGranularity` 为 `SPECIFIC`，则定义为可解释性的最后一个时间点。使用以下时间戳格式:: mm: ss yyyy-MM-ddTHH（例如：2015-01-01T20：00:00）类型：字符串长度限制：最大长度为 19。模式：`^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` 必需：否 ** [ExplainabilityConfig](#API_CreateExplainability_RequestSyntax) ** 定义可解释性的时间序列粒度和时间点的配置设置。类型：[ExplainabilityConfig](API_ExplainabilityConfig.md) 对象是否必需：是 ** [ExplainabilityName](#API_CreateExplainability_RequestSyntax) ** 可解释性的唯一名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 是否必需：是 ** [ResourceArn](#API_CreateExplainability_RequestSyntax) ** 用于创建可解释性的预测器或预测的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [Schema](#API_CreateExplainability_RequestSyntax) ** 定义数据集的字段。类型：[Schema](API_Schema.md) 对象必需：否 ** [StartDateTime](#API_CreateExplainability_RequestSyntax) ** 如果设置 `TimePointGranularity` 为 `SPECIFIC`，则定义为可解释性的第一个点。使用以下时间戳格式:: mm: ss yyyy-MM-ddTHH（例如：2015-01-01T20：00:00）类型：字符串长度限制：最大长度为 19。模式：`^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` 必需：否 ** [Tags](#API_CreateExplainability_RequestSyntax) ** 可帮助您对资源进行分类和组织的可选元数据。每个标签都包含定义的一个键和一个可选值。标签键和值区分大小写。以下限制适用于标签： + 对于每个资源，每个标签键都必须是唯一的，每个标签键必须有一个值。 + 每个资源的标签数上限： 50。 + 最大键长度：128 个 Unicode 字符（采用 UTF-8 格式） + 最大值长度：256 个 Unicode 字符（采用 UTF-8 格式） + 可接受的字符：所有字母和数字、可用 UTF-8 表示的空格以及 \$1 - =。\$1 : / @。如果您的标记架构在其他服务和资源中使用，则这些服务的字符限制也适用。 + 键前缀不能包含 `aws:` 或 `AWS:` 的任何大写或小写组合。值可以带有该前缀。如果标签值将 `aws` 作为其前缀，但键没有前缀，则 Forecast 会将其视为用户标签，并将计入 50 个标签的限制。仅具有 `aws` 的键前缀的标签不计入每个资源的标签数限制。不能编辑或删除带该前缀的标签键。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "ExplainabilityArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [ExplainabilityArn](#API_CreateExplainability_ResponseSyntax) ** 可解释性的 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateExplainability) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateExplainability) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateExplainability) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateExplainability) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateExplainability) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateExplainability) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateExplainability) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateExplainability) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateExplainability) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateExplainability) # CreateExplainabilityExport 导出 [CreateExplainability](API_CreateExplainability.md) 操作创建的可解释性资源。导出的文件将导出到 Amazon Simple Storage Service（Amazon S3）存储桶中。您必须指定一个包含亚马逊 S3 存储桶和一个 AWS Identity and Access Management (IAM) 角色的[DataDestination](API_DataDestination.md)对象，Amazon Forecast 可以代入该角色来访问亚马逊 S3 存储桶。有关更多信息，请参阅 [为 Amazon Forecast 设置权限](aws-forecast-iam-roles.md)。 **注意** 导出作业的 `Status` 必须为 `ACTIVE`，然后才能访问 Amazon S3 存储桶中的导出。要获取此状态，请使用 [DescribeExplainabilityExport](API_DescribeExplainabilityExport.md) 操作。 ## 请求语法 ``` { "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ExplainabilityArn": "string", "ExplainabilityExportName": "string", "Format": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Destination](#API_CreateExplainabilityExport_RequestSyntax) ** 导出作业的目的地。提供 S3 路径、允许 Amazon Forecast 访问该位置的 AWS Identity and Access Management (IAM) 角色和 AWS Key Management Service (KMS) 密钥（可选）。类型：[DataDestination](API_DataDestination.md) 对象是否必需：是 ** [ExplainabilityArn](#API_CreateExplainabilityExport_RequestSyntax) ** 要导出的可解释性 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [ExplainabilityExportName](#API_CreateExplainabilityExport_RequestSyntax) ** 可解释性导出的唯一名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 是否必需：是 ** [Format](#API_CreateExplainabilityExport_RequestSyntax) ** 导出数据的格式，CSV 或 PARQUET。类型：字符串长度限制：最大长度为 7。模式：`^CSV|PARQUET$` 必需：否 ** [Tags](#API_CreateExplainabilityExport_RequestSyntax) ** 可帮助您对资源进行分类和组织的可选元数据。每个标签都包含定义的一个键和一个可选值。标签键和值区分大小写。以下限制适用于标签： + 对于每个资源，每个标签键都必须是唯一的，每个标签键必须有一个值。 + 每个资源的标签数上限： 50。 + 最大键长度：128 个 Unicode 字符（采用 UTF-8 格式） + 最大值长度：256 个 Unicode 字符（采用 UTF-8 格式） + 可接受的字符：所有字母和数字、可用 UTF-8 表示的空格以及 \$1 - =。\$1 : / @。如果您的标记架构在其他服务和资源中使用，则这些服务的字符限制也适用。 + 键前缀不能包含 `aws:` 或 `AWS:` 的任何大写或小写组合。值可以带有该前缀。如果标签值将 `aws` 作为其前缀，但键没有前缀，则 Forecast 会将其视为用户标签，并将计入 50 个标签的限制。仅具有 `aws` 的键前缀的标签不计入每个资源的标签数限制。不能编辑或删除带该前缀的标签键。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "ExplainabilityExportArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [ExplainabilityExportArn](#API_CreateExplainabilityExport_ResponseSyntax) ** 导出的 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateExplainabilityExport) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateExplainabilityExport) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateExplainabilityExport) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateExplainabilityExport) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateExplainabilityExport) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateExplainabilityExport) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateExplainabilityExport) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateExplainabilityExport) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateExplainabilityExport) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateExplainabilityExport) # CreateForecast 为 `TARGET_TIME_SERIES` 数据集中用于训练预测器的每个项目创建预测。这称作推理。要以低延迟检索单个项目的预测，请使用 [QueryForecast](API_forecastquery_QueryForecast.md) 操作。要将完整的预测导出到 Amazon Simple Storage Service（Amazon S3）存储桶中，请使用 [CreateForecastExportJob](API_CreateForecastExportJob.md) 操作。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 预测范围由您在 [CreatePredictor](API_CreatePredictor.md) 请求中指定的 `ForecastHorizon` 值决定。查询预测时，您可以请求预测内的特定日期范围。要获取所有预测的列表，请使用 [ListForecasts](API_ListForecasts.md) 操作。 **注意** Amazon Forecast 生成的预测与用于创建预测器的数据集处于同一时区。有关更多信息，请参阅 [生成预测](howitworks-forecast.md)。 **注意** 在查询或导出预测之前，预测的 `Status` 必须为 `ACTIVE`。使用 [DescribeForecast](API_DescribeForecast.md) 操作获取此状态。默认情况下，预测包括数据集组中用于训练预测器的每个项目（`item_id`）的预测。但是，您可以使用 `TimeSeriesSelector` 对象生成对时间序列子集的预测。对于您指定的任何不在输入数据集中的时间序列，都将跳过创建预测。预测导出文件将不包含这些时间序列或其预测值。 ## 请求语法 ``` { "ForecastName": "string", "ForecastTypes": [ "string" ], "PredictorArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TimeSeriesSelector": { "TimeSeriesIdentifiers": { "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] } } } } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ForecastName](#API_CreateForecast_RequestSyntax) ** 预测的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 是否必需：是 ** [ForecastTypes](#API_CreateForecast_RequestSyntax) ** 生成概率预测的分位数。**目前，每个预测最多可以指定 5 个分位数**。可接受的值包括 `0.01 to 0.99`（仅以 .01 为增量）和 `mean`。当分布不对称时（例如，贝塔分布和负二项式分布），预测均值与中值（0.50）不同。默认分位数是您在创建预测器时指定的分位数。如果您未指定分位数，则默认值为 `["0.1", "0.5", "0.9"]`。类型：字符串数组数组成员：最少 1 项。最多 20 项。长度限制：最小长度为 2。最大长度为 4。模式：`(^0?\.\d\d?$|^mean$)` 必需：否 ** [PredictorArn](#API_CreateForecast_RequestSyntax) ** 用于生成预测的预测器的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [Tags](#API_CreateForecast_RequestSyntax) ** 您应用于预测以帮助您对其进行分类和组织的可选元数据。每个标签都包含定义的一个键和一个可选值。下面是适用于标签的基本限制： + 每个资源的最大标签数 - 50。 + 对于每个资源，每个标签键必须是唯一的，并且每个标签键只能有一个值。 + 最大键长度 - 128 个 Unicode 字符（采用 UTF-8 格式）。 + 最大值长度 - 256 个 Unicode 字符（采用 UTF-8 格式）。 + 如果您的标记模式针对多个服务和资源使用，请记得其它服务可能对允许使用的字符有限制。通常允许使用的字符包括：可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：\$1：= . \$1 : / @。 + 标签键和值区分大小写。 + 请勿使用`aws:``AWS:`、或任何大写或小写组合，例如密钥的前缀，因为它是保留供 AWS 使用的。不能编辑或删除带此前缀的标签键。值可以带有该前缀。如果标签值将 `aws` 作为其前缀，但键没有前缀，则 Forecast 会将其视为用户标签，并将计入 50 个标签的限制。仅具有 `aws` 的键前缀的标签不计入每个资源的标签数限制。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ** [TimeSeriesSelector](#API_CreateForecast_RequestSyntax) ** 定义用于在 `TimeSeriesIdentifiers` 对象中创建预测的时间序列集。 `TimeSeriesIdentifiers` 对象需要具备以下信息： + `DataSource` + `Format` + `Schema` 类型：[TimeSeriesSelector](API_TimeSeriesSelector.md) 对象必需：否 ## 响应语法 ``` { "ForecastArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [ForecastArn](#API_CreateForecast_ResponseSyntax) ** 预测的 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateForecast) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateForecast) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateForecast) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateForecast) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateForecast) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateForecast) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateForecast) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateForecast) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateForecast) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateForecast) # CreateForecastExportJob 将 [CreateForecast](API_CreateForecast.md) 操作创建的预测导出到 Amazon Simple Storage Service（Amazon S3）存储桶中。预测文件名将符合以下惯例： \$1\$1 其中 < ExportTimestamp > 组件在 Java 中 SimpleDateFormat（yyyy-mm-ddthhh-mm-ssz）。 **重要** Amazon Forecast 已不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 您必须指定包含 AWS Identity and Access Management （IAM）角色的 [DataDestination](API_DataDestination.md) 对象，Amazon Forecast 可以代入该角色来访问 Amazon S3 存储桶。有关更多信息，请参阅 [为 Amazon Forecast 设置权限](aws-forecast-iam-roles.md)。有关更多信息，请参阅 [生成预测](howitworks-forecast.md)。要获取所有预测导出作业的列表，请使用 [ListForecastExportJobs](API_ListForecastExportJobs.md) 操作。 **注意** 预测导出作业的 `Status` 必须为 `ACTIVE`，然后才能访问 Amazon S3 存储桶中的预测。要获取此状态，请使用 [DescribeForecastExportJob](API_DescribeForecastExportJob.md) 操作。 ## 请求语法 ``` { "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ForecastArn": "string", "ForecastExportJobName": "string", "Format": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Destination](#API_CreateForecastExportJob_RequestSyntax) ** 您要保存预测的位置，以及 Amazon Forecast 可以代入的访问该位置的 AWS Identity and Access Management (IAM) 角色。必须将预测导出到 Amazon S3 存储桶中。如果使用加密，则`Destination`必须包含 AWS Key Management Service (KMS) 密钥。IAM 角色必须允许 Amazon Forecast 访问密钥的权限。类型：[DataDestination](API_DataDestination.md) 对象是否必需：是 ** [ForecastArn](#API_CreateForecastExportJob_RequestSyntax) ** 您要导出的预测的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [ForecastExportJobName](#API_CreateForecastExportJob_RequestSyntax) ** 预测导出作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 是否必需：是 ** [Format](#API_CreateForecastExportJob_RequestSyntax) ** 导出数据的格式，CSV 或 PARQUET。默认值为 CSV。类型：字符串长度限制：最大长度为 7。模式：`^CSV|PARQUET$` 必需：否 ** [Tags](#API_CreateForecastExportJob_RequestSyntax) ** 您应用于预测导出作业以帮助您对其进行分类和组织的可选元数据。每个标签都包含定义的一个键和一个可选值。下面是适用于标签的基本限制： + 每个资源的最大标签数 - 50。 + 对于每个资源，每个标签键必须是唯一的，并且每个标签键只能有一个值。 + 最大键长度 - 128 个 Unicode 字符（采用 UTF-8 格式）。 + 最大值长度 - 256 个 Unicode 字符（采用 UTF-8 格式）。 + 如果您的标记模式针对多个服务和资源使用，请记得其它服务可能对允许使用的字符有限制。通常允许使用的字符包括：可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：\$1：= . \$1 : / @。 + 标签键和值区分大小写。 + 请勿使用`aws:``AWS:`、或任何大写或小写组合，例如密钥的前缀，因为它是保留供 AWS 使用的。不能编辑或删除带此前缀的标签键。值可以带有该前缀。如果标签值将 `aws` 作为其前缀，但键没有前缀，则 Forecast 会将其视为用户标签，并将计入 50 个标签的限制。仅具有 `aws` 的键前缀的标签不计入每个资源的标签数限制。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "ForecastExportJobArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [ForecastExportJobArn](#API_CreateForecastExportJob_ResponseSyntax) ** 导出作业的 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateForecastExportJob) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateForecastExportJob) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateForecastExportJob) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateForecastExportJob) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateForecastExportJob) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateForecastExportJob) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateForecastExportJob) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateForecastExportJob) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateForecastExportJob) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateForecastExportJob) # CreateMonitor 为现有自动预测器创建预测器监控器资源。预测器监控允许您查看预测器的性能如何随时间变化。有关更多信息，请参阅[预测器监控](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html)。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "MonitorName": "string", "ResourceArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [MonitorName](#API_CreateMonitor_RequestSyntax) ** 监控器资源的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 是否必需：是 ** [ResourceArn](#API_CreateMonitor_RequestSyntax) ** 要监控的预测器的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [Tags](#API_CreateMonitor_RequestSyntax) ** 要应用于监控器资源的[标签](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "MonitorArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [MonitorArn](#API_CreateMonitor_ResponseSyntax) ** 监控器资源的 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateMonitor) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateMonitor) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateMonitor) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateMonitor) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateMonitor) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateMonitor) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateMonitor) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateMonitor) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateMonitor) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateMonitor) # CreatePredictor **注意** 此操作创建传统预测器，该预测器不包含 Amazon Forecast 提供的所有预测器功能。要创建与 Forecast 所有方面兼容的预测器，请使用 [CreateAutoPredictor](API_CreateAutoPredictor.md)。创建 Amazon Forecast 预测器。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 在该请求中，提供一个数据集组并指定算法，或者让 Amazon Forecast 使用 AutoML 为您选择算法。如果指定算法，您还可以覆盖特定于算法的超参数。 Amazon Forecast 使用该算法采用指定数据集组中最新版本的数据集来训练预测器。然后，您可以使用 [CreateForecast](API_CreateForecast.md) 操作生成预测。要查看评估指标，请使用 [GetAccuracyMetrics](API_GetAccuracyMetrics.md) 操作。您可以指定特征化配置来填充并聚合 `TARGET_TIME_SERIES` 数据集中的数据字段，从而改进模型训练。有关更多信息，请参阅 [FeaturizationConfig](API_FeaturizationConfig.md)。对于 RELATED\$1TIME\$1SERIES 数据集，`CreatePredictor` 验证创建数据集时指定的 `DataFrequency` 是否匹配 `ForecastFrequency`。TARGET\$1TIME\$1SERIES 数据集没有此限制。Amazon Forecast 还会验证分隔符和时间戳格式。有关更多信息，请参阅 [导入数据集](howitworks-datasets-groups.md)。默认情况下，预测器以 0.1（P10）、0.5（P50）和 0.9 （P90）分位数进行训练和评估。您可以通过设置 `ForecastTypes` 来选择自定义预测类型来训练和评估预测器。 **AutoML** 如果您希望 Amazon Forecast 评估每种算法并选择最大限度地减少 `objective function` 的算法，请设置 `PerformAutoML` 为 `true`。定义 `objective function` 为预测类型的加权损失均值。默认情况下，这些损失是 p10、p50 和 p90 分位数损失。有关更多信息，请参阅 [EvaluationResult](API_EvaluationResult.md)。启用 AutoML 时，不允许使用以下属性： + `AlgorithmArn` + `HPOConfig` + `PerformHPO` + `TrainingParameters` 要获取所有预测器的列表，请使用 [ListPredictors](API_ListPredictors.md) 操作。 **注意** 在使用预测器创建预测之前，预测器的 `Status` 必须为 `ACTIVE`，表示训练已完成。要获取此状态，请使用 [DescribePredictor](API_DescribePredictor.md) 操作。 ## 请求语法 ``` { "AlgorithmArn": "string", "AutoMLOverrideStrategy": "string", "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "EvaluationParameters": { "BackTestWindowOffset": number, "NumberOfBacktestWindows": number }, "FeaturizationConfig": { "Featurizations": [ { "AttributeName": "string", "FeaturizationPipeline": [ { "FeaturizationMethodName": "string", "FeaturizationMethodParameters": { "string" : "string" } } ] } ], "ForecastDimensions": [ "string" ], "ForecastFrequency": "string" }, "ForecastHorizon": number, "ForecastTypes": [ "string" ], "HPOConfig": { "ParameterRanges": { "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": number, "MinValue": number, "Name": "string", "ScalingType": "string" } ], "IntegerParameterRanges": [ { "MaxValue": number, "MinValue": number, "Name": "string", "ScalingType": "string" } ] } }, "InputDataConfig": { "DatasetGroupArn": "string", "SupplementaryFeatures": [ { "Name": "string", "Value": "string" } ] }, "OptimizationMetric": "string", "PerformAutoML": boolean, "PerformHPO": boolean, "PredictorName": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TrainingParameters": { "string" : "string" } } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [AlgorithmArn](#API_CreatePredictor_RequestSyntax) ** 用于模型训练的算法的 Amazon 资源名称（ARN）。如果未将 `PerformAutoML` 设置为 `true`，则是必需。 **支持的算法：** + `arn:aws:forecast:::algorithm/ARIMA` + `arn:aws:forecast:::algorithm/CNN-QR` + `arn:aws:forecast:::algorithm/Deep_AR_Plus` + `arn:aws:forecast:::algorithm/ETS` + `arn:aws:forecast:::algorithm/NPTS` + `arn:aws:forecast:::algorithm/Prophet` 类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：否 ** [AutoMLOverrideStrategy](#API_CreatePredictor_RequestSyntax) ** `LatencyOptimized` AutoML 覆盖策略仅在私有测试版中可用。请联系 Su AWS pport 或您的客户经理，详细了解访问权限。用于覆盖默认的 AutoML 策略，即优化预测器的准确性。要应用可最大限度地缩短训练时间的 AutoML 策略，请使用 `LatencyOptimized`。此参数仅对使用 AutoML 训练的预测器有效。类型：字符串有效值：`LatencyOptimized | AccuracyOptimized` 必需：否 ** [EncryptionConfig](#API_CreatePredictor_RequestSyntax) ** AWS Key Management Service (KMS) 密钥和 Amazon Forecast 可以代入的访问密钥的 AWS Identity and Access Management (IAM) 角色。类型：[EncryptionConfig](API_EncryptionConfig.md) 对象必需：否 ** [EvaluationParameters](#API_CreatePredictor_RequestSyntax) ** 用于覆盖指定算法的默认评估参数。Amazon Forecast 通过将数据集拆分为训练数据和测试数据来评估预测器。评估参数定义了如何执行拆分和迭代次数。类型：[EvaluationParameters](API_EvaluationParameters.md) 对象必需：否 ** [FeaturizationConfig](#API_CreatePredictor_RequestSyntax) ** 特征化配置。类型：[FeaturizationConfig](API_FeaturizationConfig.md) 对象是否必需：是 ** [ForecastHorizon](#API_CreatePredictor_RequestSyntax) ** 指定训练模型来预测的时间步长数。预测范围也称为预测长度。例如，如果您为每日数据集合配置数据集（使用 [CreateDataset](API_CreateDataset.md) 操作的 `DataFrequency`参数），并将预测范围设置为 10，则模型将返回 10 天的预测。最大预测范围是 500 个时间步长或 TARGET\$1TIME\$1SERIES 数据集长度的 1/3 中较小的一个。类型：整数是否必需：是 ** [ForecastTypes](#API_CreatePredictor_RequestSyntax) ** 指定用于训练预测器的预测类型。您最多可指定五种预测类型。预测类型可以是从 0.01 到 0.99 的分位数，增量为 0.01 或更高。您也可以使用 `mean` 指定均值预测。默认值为 `["0.10", "0.50", "0.9"]`。类型：字符串数组数组成员：最少 1 项。最多 20 项。长度限制：最小长度为 2。最大长度为 4。模式：`(^0?\.\d\d?$|^mean$)` 必需：否 ** [HPOConfig](#API_CreatePredictor_RequestSyntax) ** 为算法提供超参数覆盖值。如果您未提供此参数，Amazon Forecast 将使用默认值。各个算法指定哪些超参数支持超参数优化（HPO）。有关更多信息，请参阅 [Amazon Forecast 算法](aws-forecast-choosing-recipes.md)。如果包含 `HPOConfig` 对象，则必须设置 `PerformHPO` 为 true。类型：[HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) 对象必需：否 ** [InputDataConfig](#API_CreatePredictor_RequestSyntax) ** 描述包含要用于训练预测器的数据的数据集组。类型：[InputDataConfig](API_InputDataConfig.md) 对象是否必需：是 ** [OptimizationMetric](#API_CreatePredictor_RequestSyntax) ** 用于优化预测器的准确性指标。默认值为 `AverageWeightedQuantileLoss`。类型：字符串有效值：`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 必需：否 ** [PerformAutoML](#API_CreatePredictor_RequestSyntax) ** 是否执行 AutoML。当 Amazon Forecast 执行 AutoML 时，它会评估其提供的算法，并为您的训练数据集选择最佳算法和配置。默认值为 `false`。在这种情况下，需要指定算法。将 `PerformAutoML` 设置为 `true`，使 Amazon Forecast 执行 AutoML。如果您不确定哪种算法适合您的训练数据，那么这是一个不错的选择。在这种情况下，`PerformHPO` 必须为 false。类型：布尔值必需：否 ** [PerformHPO](#API_CreatePredictor_RequestSyntax) ** 是否执行超参数优化（HPO）。HPO 会为您的训练数据找到最佳的超参数值。执行 HPO 的过程称为运行超参数优化作业。默认值为 `false`。在这种情况下，Amazon Forecast 使用所选算法中的默认超参数值。要覆盖默认值，请将 `PerformHPO` 设置为 `true`，也可以提供 [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) 对象。优化作业指定要优化的指标、哪些超参数参与优化以及每个可优化参数的有效范围。在这种情况下，您需要指定算法，并且 `PerformAutoML` 必须为 false。下列算法支持 HPO： + DeepAR\$1 + CNN-QR 类型：布尔值必需：否 ** [PredictorName](#API_CreatePredictor_RequestSyntax) ** 预测器的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 是否必需：是 ** [Tags](#API_CreatePredictor_RequestSyntax) ** 您应用于预测器以帮助您对其进行分类和组织的可选元数据。每个标签都包含定义的一个键和一个可选值。下面是适用于标签的基本限制： + 每个资源的最大标签数 - 50。 + 对于每个资源，每个标签键必须是唯一的，并且每个标签键只能有一个值。 + 最大键长度 - 128 个 Unicode 字符（采用 UTF-8 格式）。 + 最大值长度 - 256 个 Unicode 字符（采用 UTF-8 格式）。 + 如果您的标记模式针对多个服务和资源使用，请记得其它服务可能对允许使用的字符有限制。通常允许使用的字符包括：可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：\$1：= . \$1 : / @。 + 标签键和值区分大小写。 + 请勿使用`aws:``AWS:`、或任何大写或小写组合，例如密钥的前缀，因为它是保留供 AWS 使用的。不能编辑或删除带此前缀的标签键。值可以带有该前缀。如果标签值将 `aws` 作为其前缀，但键没有前缀，则 Forecast 会将其视为用户标签，并将计入 50 个标签的限制。仅具有 `aws` 的键前缀的标签不计入每个资源的标签数限制。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ** [TrainingParameters](#API_CreatePredictor_RequestSyntax) ** 模型训练中要覆盖的超参数。您可以覆盖的超参数在各个算法中列出。有关支持的算法的列表，请参阅 [Amazon Forecast 算法](aws-forecast-choosing-recipes.md)。类型：字符串到字符串映射映射条目：最低 0 项。最多 100 个项目。密钥长度限制：最大长度为 256。键模式：`^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$` 值长度限制：最大长度为 256。值模式：`^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$` 必需：否 ## 响应语法 ``` { "PredictorArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [PredictorArn](#API_CreatePredictor_ResponseSyntax) ** 预测器的 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreatePredictor) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreatePredictor) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreatePredictor) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreatePredictor) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreatePredictor) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreatePredictor) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreatePredictor) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreatePredictor) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreatePredictor) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreatePredictor) # CreatePredictorBacktestExportJob 导出 [CreateAutoPredictor](API_CreateAutoPredictor.md) 或 [CreatePredictor](API_CreatePredictor.md) 操作生成的回测预测和准确性指标。包含 CSV 或 Parquet 文件的两个文件夹将导出到您指定的 S3 存储桶。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 导出文件名将符合以下惯例： `__.csv` < ExportTimestamp > 组件采用 Java SimpleDate 格式（yyyy-mm-ddthhh-mm-ssz）。您必须指定一个包含亚马逊 S3 存储桶和一个 AWS Identity and Access Management (IAM) 角色的[DataDestination](API_DataDestination.md)对象，Amazon Forecast 可以代入该角色来访问亚马逊 S3 存储桶。有关更多信息，请参阅 [为 Amazon Forecast 设置权限](aws-forecast-iam-roles.md)。 **注意** 导出作业的 `Status` 必须为 `ACTIVE`，然后才能访问 Amazon S3 存储桶中的导出。要获取此状态，请使用 [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md) 操作。 ## 请求语法 ``` { "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "PredictorArn": "string", "PredictorBacktestExportJobName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Destination](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** 导出作业的目的地。提供 S3 路径、允许 Amazon Forecast 访问该位置的 AWS Identity and Access Management (IAM) 角色和 AWS Key Management Service (KMS) 密钥（可选）。类型：[DataDestination](API_DataDestination.md) 对象是否必需：是 ** [Format](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** 导出数据的格式，CSV 或 PARQUET。默认值为 CSV。类型：字符串长度限制：最大长度为 7。模式：`^CSV|PARQUET$` 必需：否 ** [PredictorArn](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** 您要导出的预测器的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [PredictorBacktestExportJobName](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** 回测导出作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 是否必需：是 ** [Tags](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** 可帮助您对回测进行分类和组织的可选元数据。每个标签都包含定义的一个键和一个可选值。标签键和值区分大小写。以下限制适用于标签： + 对于每个资源，每个标签键都必须是唯一的，每个标签键必须有一个值。 + 每个资源的标签数上限： 50。 + 最大键长度：128 个 Unicode 字符（采用 UTF-8 格式） + 最大值长度：256 个 Unicode 字符（采用 UTF-8 格式） + 可接受的字符：所有字母和数字、可用 UTF-8 表示的空格以及 \$1 - =。\$1 : / @。如果您的标记架构在其他服务和资源中使用，则这些服务的字符限制也适用。 + 键前缀不能包含 `aws:` 或 `AWS:` 的任何大写或小写组合。值可以带有该前缀。如果标签值将 `aws` 作为其前缀，但键没有前缀，则 Forecast 会将其视为用户标签，并将计入 50 个标签的限制。仅具有 `aws` 的键前缀的标签不计入每个资源的标签数限制。不能编辑或删除带该前缀的标签键。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "PredictorBacktestExportJobArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [PredictorBacktestExportJobArn](#API_CreatePredictorBacktestExportJob_ResponseSyntax) ** 要导出的预测器回测导出作业的 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) # CreateWhatIfAnalysis 假设分析是一种情景建模技术，您可以对时间序列进行假设更改，并将这些更改生成的预测与基准、未更改的时间序列进行比较。重要的是要记住，假设分析的目的是了解在对基准时间序列进行不同修改的情况下，预测会如何变化。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 例如，假设您是一家服装零售商，正在考虑季末促销，为新款式腾出空间。创建基准预测后，您可以使用假设分析来调查不同的销售策略可能如何影响您的目标。您可以创建一个场景，让所有商品都降价 25％，而另一个场景是所有商品都给予固定金额的降价。您可以创建一个场景，让销售持续一周，而另一个场景是让销售持续一个月。通过假设分析，您可以对许多不同的场景进行相互比较。请注意，假设分析旨在显示预测模型已了解的内容，以及它在您正在评估的场景中的行为方式。不要盲目使用假设分析的结果来做出业务决策。例如，在没有可用参考来确定预测是否准确的新场景中，预测可能不准确。 [TimeSeriesSelector](API_TimeSeriesSelector.md) 对象定义了您想要在假设分析中使用的项目。 **注意** 您的数据必须采用逗号分隔值（CSV）格式，以创建假设分析。 ## 请求语法 ``` { "ForecastArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TimeSeriesSelector": { "TimeSeriesIdentifiers": { "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] } } }, "WhatIfAnalysisName": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ForecastArn](#API_CreateWhatIfAnalysis_RequestSyntax) ** 基准预测的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [Tags](#API_CreateWhatIfAnalysis_RequestSyntax) ** 适用于假设分析预测的[标签](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ** [TimeSeriesSelector](#API_CreateWhatIfAnalysis_RequestSyntax) ** 定义在对 `TimeSeriesIdentifiers` 对象进行假设分析时使用的一组时间序列。假设分析仅针对此对象中的时间序列执行。 `TimeSeriesIdentifiers` 对象需要具备以下信息： + `DataSource` + `Format` + `Schema` 类型：[TimeSeriesSelector](API_TimeSeriesSelector.md) 对象必需：否 ** [WhatIfAnalysisName](#API_CreateWhatIfAnalysis_RequestSyntax) ** 假设分析的名称。各名称必须唯一。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 必需：是 ## 响应语法 ``` { "WhatIfAnalysisArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [WhatIfAnalysisArn](#API_CreateWhatIfAnalysis_ResponseSyntax) ** 假设分析的 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfAnalysis) # CreateWhatIfForecast 假设分析预测是根据基准预测的修改版本创建的预测。每个假设分析预测都包含一个替换数据集或对原始数据集的一组转换。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "Tags": [ { "Key": "string", "Value": "string" } ], "TimeSeriesReplacementsDataSource": { "Format": "string", "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" }, "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "TimestampFormat": "string" }, "TimeSeriesTransformations": [ { "Action": { "AttributeName": "string", "Operation": "string", "Value": number }, "TimeSeriesConditions": [ { "AttributeName": "string", "AttributeValue": "string", "Condition": "string" } ] } ], "WhatIfAnalysisArn": "string", "WhatIfForecastName": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Tags](#API_CreateWhatIfForecast_RequestSyntax) ** 适用于假设分析预测的[标签](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ** [TimeSeriesReplacementsDataSource](#API_CreateWhatIfForecast_RequestSyntax) ** 替换时间序列数据集，其中包含要在相关时间序列数据集中更改的行。替换时间序列不必包含与基准相关的时间序列中的所有行。仅包含您想要包含在假设分析预测中的行（度量维度组合）。此数据集与原始时间序列合并，以创建用于假设分析的转换数据集。此数据集应包含要修改的项目（例如 item\$1id 或 workforce\$1type）、任何相关维度、时间戳列以及至少一个相关时间序列列。此文件不应包含相同时间序列的重复时间戳。此文件必须采用 CSV 格式。未包含在此数据集中的时间戳和 item\$1id 不会包含在假设分析中。类型：[TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) 对象必需：否 ** [TimeSeriesTransformations](#API_CreateWhatIfForecast_RequestSyntax) ** 应用于基准时间序列的转换。每个转换都包含一个操作和一组条件。仅当在满足所有条件时才会应用操作。如果未提供任何条件，则操作将应用于所有项目。类型：[TimeSeriesTransformation](API_TimeSeriesTransformation.md) 对象数组数组成员：最少 0 个物品。最多 30 项。必需：否 ** [WhatIfAnalysisArn](#API_CreateWhatIfForecast_RequestSyntax) ** 假设分析的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [WhatIfForecastName](#API_CreateWhatIfForecast_RequestSyntax) ** 假设分析预测的名称。每个假设分析中的名称必须唯一。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 必需：是 ## 响应语法 ``` { "WhatIfForecastArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [WhatIfForecastArn](#API_CreateWhatIfForecast_ResponseSyntax) ** 假设分析预测的 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateWhatIfForecast) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfForecast) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfForecast) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfForecast) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfForecast) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfForecast) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfForecast) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfForecast) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfForecast) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfForecast) # CreateWhatIfForecastExport 将 [CreateWhatIfForecast](API_CreateWhatIfForecast.md) 操作创建的预测导出到 Amazon Simple Storage Service（Amazon S3）存储桶中。预测文件名将符合以下惯例： `≈__` < ExportTimestamp > 组件使用的是 Java SimpleDateFormat (yyy-mm-ddthhh-mm-ssz)。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 您必须指定包含 AWS Identity and Access Management （IAM）角色的 [DataDestination](API_DataDestination.md) 对象，Amazon Forecast 可以代入该角色来访问 Amazon S3 存储桶。有关更多信息，请参阅 [为 Amazon Forecast 设置权限](aws-forecast-iam-roles.md)。有关更多信息，请参阅 [生成预测](howitworks-forecast.md)。要获取所有假设分析预测导出作业的列表，请使用 [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md) 操作。 **注意** 预测导出作业的 `Status` 必须为 `ACTIVE`，然后才能访问 Amazon S3 存储桶中的预测。要获取此状态，请使用 [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) 操作。 ## 请求语法 ``` { "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "WhatIfForecastArns": [ "string" ], "WhatIfForecastExportName": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Destination](#API_CreateWhatIfForecastExport_RequestSyntax) ** 您要保存预测的位置，以及 Amazon Forecast 可以代入的访问该位置的 AWS Identity and Access Management (IAM) 角色。必须将预测导出到 Amazon S3 存储桶中。如果使用加密，则`Destination`必须包含 AWS Key Management Service (KMS) 密钥。IAM 角色必须允许 Amazon Forecast 访问密钥的权限。类型：[DataDestination](API_DataDestination.md) 对象是否必需：是 ** [Format](#API_CreateWhatIfForecastExport_RequestSyntax) ** 导出数据的格式，CSV 或 PARQUET。类型：字符串长度限制：最大长度为 7。模式：`^CSV|PARQUET$` 必需：否 ** [Tags](#API_CreateWhatIfForecastExport_RequestSyntax) ** 适用于假设分析预测的[标签](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ** [WhatIfForecastArns](#API_CreateWhatIfForecastExport_RequestSyntax) ** 假设预测要导出的亚马逊资源名称 (ARNs) 列表。类型：字符串数组数组成员：最少 1 个物品。最多 50 项。长度限制：最大长度为 300。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [WhatIfForecastExportName](#API_CreateWhatIfForecastExport_RequestSyntax) ** 要导出的假设分析预测的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` 必需：是 ## 响应语法 ``` { "WhatIfForecastExportArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [WhatIfForecastExportArn](#API_CreateWhatIfForecastExport_ResponseSyntax) ** 假设分析预测的 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfForecastExport) # DeleteDataset 删除使用该[CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)操作创建的 Amazon Forecast 数据集。您只能删除状态为 `ACTIVE` 或 `CREATE_FAILED` 的数据集。要获取状态，请使用[DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html)操作。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) **注意** Forecast 不会自动更新包含已删除数据集的任何数据集组。要更新数据集组，请使用[UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)操作，省略已删除数据集的 ARN。 ## 请求语法 ``` { "DatasetArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [DatasetArn](#API_DeleteDataset_RequestSyntax) ** 要删除的数据集的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteDataset) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDataset) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDataset) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDataset) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDataset) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDataset) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDataset) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDataset) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDataset) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDataset) # DeleteDatasetGroup 删除使用[CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)操作创建的数据集组。您只能删除状态为 `ACTIVE`、`CREATE_FAILED` 或 `UPDATE_FAILED` 的数据集组。使用 [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) 操作获取状态。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 此操作仅删除数据集组，不删除组中的数据集。 ## 请求语法 ``` { "DatasetGroupArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [DatasetGroupArn](#API_DeleteDatasetGroup_RequestSyntax) ** 要删除的数据集组的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteDatasetGroup) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDatasetGroup) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDatasetGroup) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDatasetGroup) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDatasetGroup) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDatasetGroup) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDatasetGroup) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDatasetGroup) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDatasetGroup) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDatasetGroup) # DeleteDatasetImportJob 删除使用该[CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)操作创建的数据集导入任务。您只能删除状态为 `ACTIVE` 或 `CREATE_FAILED` 的数据集导入作业。使用 [DescribeDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) 操作获取状态。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "DatasetImportJobArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [DatasetImportJobArn](#API_DeleteDatasetImportJob_RequestSyntax) ** 要删除的数据集导入作业的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDatasetImportJob) # DeleteExplainability 删除可解释性资源。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 只能删除状态为 `ACTIVE` 或 `CREATE_FAILED` 的预测器。使用 [DescribeExplainability](API_DescribeExplainability.md) 操作获取状态。 ## 请求语法 ``` { "ExplainabilityArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ExplainabilityArn](#API_DeleteExplainability_RequestSyntax) ** 要删除的可解释性资源的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteExplainability) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteExplainability) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteExplainability) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteExplainability) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteExplainability) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteExplainability) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteExplainability) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteExplainability) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteExplainability) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteExplainability) # DeleteExplainabilityExport 删除可解释性导出。 ## 请求语法 ``` { "ExplainabilityExportArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ExplainabilityExportArn](#API_DeleteExplainabilityExport_RequestSyntax) ** 要删除的可解释性导出的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteExplainabilityExport) # DeleteForecast 删除使用 [CreateForecast](API_CreateForecast.md) 操作创建的预测。您只能删除状态为 `ACTIVE` 或 `CREATE_FAILED` 的预测。使用 [DescribeForecast](API_DescribeForecast.md) 操作获取状态。您无法在导出预测时删除预测。删除某个预测后，您将无法再查询该预测。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "ForecastArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ForecastArn](#API_DeleteForecast_RequestSyntax) ** 要删除的预测的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteForecast) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteForecast) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteForecast) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteForecast) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteForecast) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteForecast) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteForecast) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteForecast) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteForecast) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteForecast) # DeleteForecastExportJob 删除使用 [CreateForecastExportJob](API_CreateForecastExportJob.md) 操作创建的预测导出作业。您只能删除状态为 `ACTIVE` 或 `CREATE_FAILED` 的导出作业。要获取状态，请使用 [DescribeForecastExportJob](API_DescribeForecastExportJob.md) 操作。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "ForecastExportJobArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ForecastExportJobArn](#API_DeleteForecastExportJob_RequestSyntax) ** 要删除的预测导出作业的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteForecastExportJob) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteForecastExportJob) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteForecastExportJob) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteForecastExportJob) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteForecastExportJob) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteForecastExportJob) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteForecastExportJob) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteForecastExportJob) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteForecastExportJob) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteForecastExportJob) # DeleteMonitor 删除监控器资源。您只能删除状态为 `ACTIVE`、`ACTIVE_STOPPED`、`CREATE_FAILED` 或 `CREATE_STOPPED` 的监控器资源。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "MonitorArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [MonitorArn](#API_DeleteMonitor_RequestSyntax) ** 要删除的监控器资源的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteMonitor) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteMonitor) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteMonitor) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteMonitor) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteMonitor) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteMonitor) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteMonitor) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteMonitor) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteMonitor) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteMonitor) # DeletePredictor 删除使用 [DescribePredictor](API_DescribePredictor.md) 或 [CreatePredictor](API_CreatePredictor.md) 操作创建的预测器。只能删除状态为 `ACTIVE` 或 `CREATE_FAILED` 的预测器。使用 [DescribePredictor](API_DescribePredictor.md) 操作获取状态。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "PredictorArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [PredictorArn](#API_DeletePredictor_RequestSyntax) ** 要删除的预测器的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeletePredictor) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeletePredictor) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeletePredictor) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeletePredictor) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeletePredictor) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeletePredictor) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeletePredictor) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeletePredictor) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeletePredictor) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeletePredictor) # DeletePredictorBacktestExportJob 删除预测器回测导出作业。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "PredictorBacktestExportJobArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [PredictorBacktestExportJobArn](#API_DeletePredictorBacktestExportJob_RequestSyntax) ** 要删除的预测器回测导出作业的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) # DeleteResourceTree 删除整个资源树。该操作将删除父资源及其子资源。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 子资源是指从其他资源创建的资源。例如，当预测器生成预测时，预测是子资源，预测器是父资源。 Amazon Forecast 资源拥有以下父子资源层次结构： + **数据集**：数据集导入作业 + **数据集组**：预测器、预测器回测导出作业、预测、预测导出作业 + **预测器**：预测器回测导出作业、预测、预测导出作业 + **预测**：预测导出作业 **注意** `DeleteResourceTree` 只会删除 Amazon Forecast 资源，不会删除存储在 Amazon S3 中的数据集或导出的文件。 ## 请求语法 ``` { "ResourceArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ResourceArn](#API_DeleteResourceTree_RequestSyntax) ** 要删除的父资源的 Amazon 资源名称（ARN）。父资源的所有子资源也将被删除。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteResourceTree) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteResourceTree) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteResourceTree) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteResourceTree) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteResourceTree) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteResourceTree) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteResourceTree) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteResourceTree) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteResourceTree) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteResourceTree) # DeleteWhatIfAnalysis 删除使用 [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) 操作创建的假设分析。您只能删除状态为 `ACTIVE` 或 `CREATE_FAILED` 的假设分析。使用 [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) 操作获取状态。在导出假设分析的任何预测时，您无法删除假设分析。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "WhatIfAnalysisArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [WhatIfAnalysisArn](#API_DeleteWhatIfAnalysis_RequestSyntax) ** 要删除的假设分析的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfAnalysis) # DeleteWhatIfForecast 删除使用 [CreateWhatIfForecast](API_CreateWhatIfForecast.md) 操作创建的假设分析预测。您只能删除状态为 `ACTIVE` 或 `CREATE_FAILED` 的假设分析预测。使用 [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) 操作获取状态。您无法在导出假设分析预测时将其删除。删除假设分析预测后，您将无法再查询假设分析。 ## 请求语法 ``` { "WhatIfForecastArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [WhatIfForecastArn](#API_DeleteWhatIfForecast_RequestSyntax) ** 要删除的假设分析预测的 Amazon 资源名称（ARN）。类型：字符串长度限制：最大长度为 300。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfForecast) # DeleteWhatIfForecastExport 删除使用 [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) 操作创建的假设分析预测导出。只能删除状态为 `ACTIVE` 或 `CREATE_FAILED` 的假设分析预测导出。使用 [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) 操作获取状态。 ## 请求语法 ``` { "WhatIfForecastExportArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [WhatIfForecastExportArn](#API_DeleteWhatIfForecastExport_RequestSyntax) ** 希望删除的假设分析预测导出的 Amazon 资源名称（ARN）。类型：字符串长度限制：最大长度为 300。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfForecastExport) # DescribeAutoPredictor 描述使用该 CreateAutoPredictor 操作创建的预测变量。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "PredictorArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [PredictorArn](#API_DescribeAutoPredictor_RequestSyntax) ** 预测器的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`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" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [CreationTime](#API_DescribeAutoPredictor_ResponseSyntax) ** CreateAutoPredictor 请求的时间戳。类型：时间戳 ** [DataConfig](#API_DescribeAutoPredictor_ResponseSyntax) ** 您的数据集组和任何其他数据集的数据配置。类型：[DataConfig](API_DataConfig.md) 对象 ** [DatasetImportJobArns](#API_DescribeAutoPredictor_ResponseSyntax) ** 用于为预测器导入训练数据的数据集导入任务的数组。 ARNs 类型：字符串数组长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [EncryptionConfig](#API_DescribeAutoPredictor_ResponseSyntax) ** Amazon Forecast 可以代入的 AWS Key Management Service AWS Identity and Access Management (KMS) 密钥和 (IAM) 角色来访问该密钥。您可以在 [CreateDataset](API_CreateDataset.md) 和 [CreatePredictor](API_CreatePredictor.md) 请求中指定这个可选对象。类型：[EncryptionConfig](API_EncryptionConfig.md) 对象 ** [EstimatedTimeRemainingInMinutes](#API_DescribeAutoPredictor_ResponseSyntax) ** 完成预测器训练作业的估计剩余时间（分钟）。类型：长整型 ** [ExplainabilityInfo](#API_DescribeAutoPredictor_ResponseSyntax) ** 提供预测器可解释性的状态和 ARN。类型：[ExplainabilityInfo](API_ExplainabilityInfo.md) 对象 ** [ForecastDimensions](#API_DescribeAutoPredictor_ResponseSyntax) ** 维度（字段）名称数组，用于指定在时间序列分组中使用的属性。类型：字符串数组数组成员：最少 1 个物品。最多 10 项。长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [ForecastFrequency](#API_DescribeAutoPredictor_ResponseSyntax) ** 预测中的预测频率。有效间隔为 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) ** 模型预测的时间步长数。预测范围也称为预测长度。类型：整数 ** [ForecastTypes](#API_DescribeAutoPredictor_ResponseSyntax) ** 预测器训练期间使用的预测类型。默认值为 ["0.1","0.5","0.9"]。类型：字符串数组数组成员：最少 1 项。最多 20 项。长度限制：最小长度为 2。最大长度为 4。模式：`(^0?\.\d\d?$|^mean$)` ** [LastModificationTime](#API_DescribeAutoPredictor_ResponseSyntax) ** 上次修改资源的时间。时间戳取决于作业的状态： + `CREATE_PENDING` - `CreationTime`。 + `CREATE_IN_PROGRESS` - 当前时间戳。 + `CREATE_STOPPING` - 当前时间戳。 + `CREATE_STOPPED` - 当作业停止时。 + `ACTIVE` 或者 `CREATE_FAILED` - 当作业完成或失败时。类型：时间戳 ** [Message](#API_DescribeAutoPredictor_ResponseSyntax) ** 如果出现错误，则会显示详细的错误原因信息。类型：字符串 ** [MonitorInfo](#API_DescribeAutoPredictor_ResponseSyntax) ** 包含 Amazon 资源名称（ARN）和监控资源状态的 [MonitorInfo](API_MonitorInfo.md) 对象。类型：[MonitorInfo](API_MonitorInfo.md) 对象 ** [OptimizationMetric](#API_DescribeAutoPredictor_ResponseSyntax) ** 用于优化预测器的准确性指标。类型：字符串有效值：`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` ** [PredictorArn](#API_DescribeAutoPredictor_ResponseSyntax) ** 预测器的 Amazon 资源名称（ARN）类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [PredictorName](#API_DescribeAutoPredictor_ResponseSyntax) ** 预测器的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [ReferencePredictorSummary](#API_DescribeAutoPredictor_ResponseSyntax) ** 参考预测器的 ARN 和状态。该参数仅对重新训练和升级的预测器有效。类型：[ReferencePredictorSummary](API_ReferencePredictorSummary.md) 对象 ** [Status](#API_DescribeAutoPredictor_ResponseSyntax) ** 预测器的状态。状态包括： + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 类型：字符串长度约束：最大长度为 256。 ** [TimeAlignmentBoundary](#API_DescribeAutoPredictor_ResponseSyntax) ** Forecast 在聚合数据时使用的时间边界。类型：[TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) 对象 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeAutoPredictor) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeAutoPredictor) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeAutoPredictor) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeAutoPredictor) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeAutoPredictor) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeAutoPredictor) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeAutoPredictor) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeAutoPredictor) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeAutoPredictor) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeAutoPredictor) # DescribeDataset 描述使用该[CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)操作创建的 Amazon Forecast 数据集。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 除了列出 `CreateDataset` 请求中指定的参数外，该操作还包括以下数据集属性： + `CreationTime` + `LastModificationTime` + `Status` ## 请求语法 ``` { "DatasetArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [DatasetArn](#API_DescribeDataset_RequestSyntax) ** 数据集的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "CreationTime": number, "DataFrequency": "string", "DatasetArn": "string", "DatasetName": "string", "DatasetType": "string", "Domain": "string", "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "LastModificationTime": number, "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "Status": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [CreationTime](#API_DescribeDataset_ResponseSyntax) ** 创建数据集的时间。类型：时间戳 ** [DataFrequency](#API_DescribeDataset_ResponseSyntax) ** 数据收集的频率。有效间隔为 Y（年）、M（月）、W（周）、D（日）、H（小时）、30min（30 分钟）、15min（15 分钟）、10min（10 分钟）、5min（5 分钟）和 1min（1 分钟）。例如，“M”表示每个月，“30min”表示每 30 分钟。类型：字符串长度限制：最小长度为 1。最大长度为 5。模式：`^Y|M|W|D|H|30min|15min|10min|5min|1min$` ** [DatasetArn](#API_DescribeDataset_ResponseSyntax) ** 数据集的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetName](#API_DescribeDataset_ResponseSyntax) ** 数据集的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [DatasetType](#API_DescribeDataset_ResponseSyntax) ** 数据集类型。类型：字符串有效值：`TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA` ** [Domain](#API_DescribeDataset_ResponseSyntax) ** 与数据集关联的域。类型：字符串有效值：`RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` ** [EncryptionConfig](#API_DescribeDataset_ResponseSyntax) ** Amazon Forecast 可以代入的 AWS Key Management Service AWS Identity and Access Management (KMS) 密钥和 (IAM) 角色来访问该密钥。类型：[EncryptionConfig](API_EncryptionConfig.md) 对象 ** [LastModificationTime](#API_DescribeDataset_ResponseSyntax) ** 创建数据集时，`LastModificationTime` 与 `CreationTime` 相同。当数据被导入数据集时，`LastModificationTime` 是 `DescribeDataset` 调用的当前时间。[CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)操作完成后，`LastModificationTime`是指导入任务完成或失败的时候。类型：时间戳 ** [Schema](#API_DescribeDataset_ResponseSyntax) ** 用于指定数据集字段的 `SchemaAttribute` 对象数组。每个 `SchemaAttribute` 都指定字段的名称和数据类型。类型：[Schema](API_Schema.md) 对象 ** [Status](#API_DescribeDataset_ResponseSyntax) ** 数据集的状态。状态包括： + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` + `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED` 这些`UPDATE`状态适用于通过调用[CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)操作将数据导入数据集并反映数据集导入任务的状态。例如，当导入作业状态为 `CREATE_IN_PROGRESS` 时，数据集的状态为 `UPDATE_IN_PROGRESS`。在可以导入训练数据之前，数据集的 `Status` 必须为 `ACTIVE`。类型：字符串长度约束：最大长度为 256。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeDataset) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDataset) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDataset) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDataset) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDataset) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDataset) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDataset) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDataset) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDataset) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDataset) # DescribeDatasetGroup 描述使用[CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)操作创建的数据集组。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 除了列出 `CreateDatasetGroup` 请求中提供的参数外，该操作还包括以下属性： + `DatasetArns` - 属于该组的数据集。 + `CreationTime` + `LastModificationTime` + `Status` ## 请求语法 ``` { "DatasetGroupArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [DatasetGroupArn](#API_DescribeDatasetGroup_RequestSyntax) ** 数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "CreationTime": number, "DatasetArns": [ "string" ], "DatasetGroupArn": "string", "DatasetGroupName": "string", "Domain": "string", "LastModificationTime": number, "Status": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [CreationTime](#API_DescribeDatasetGroup_ResponseSyntax) ** 创建数据集组的时间。类型：时间戳 ** [DatasetArns](#API_DescribeDatasetGroup_ResponseSyntax) ** 数据集组中包含的数据集的 Amazon 资源名称 (ARNs) 数组。类型：字符串数组长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetGroupArn](#API_DescribeDatasetGroup_ResponseSyntax) ** 数据集组的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetGroupName](#API_DescribeDatasetGroup_ResponseSyntax) ** 数据集组的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [Domain](#API_DescribeDatasetGroup_ResponseSyntax) ** 与数据集组关联的域。类型：字符串有效值：`RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` ** [LastModificationTime](#API_DescribeDatasetGroup_ResponseSyntax) ** 通过调用[UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)操作创建数据集组或上次更新数据集组的时间。更新数据集组时，`LastModificationTime` 是 `DescribeDatasetGroup` 调用的当前时间。类型：时间戳 ** [Status](#API_DescribeDatasetGroup_ResponseSyntax) ** 数据集组的状态。状态包括： + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` + `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED` 当您调用[UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)操作时，`UPDATE`状态将适用。数据集组的 `Status` 必须为 `ACTIVE`，然后才能使用数据集组创建预测器。类型：字符串长度约束：最大长度为 256。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeDatasetGroup) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDatasetGroup) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDatasetGroup) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDatasetGroup) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDatasetGroup) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDatasetGroup) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDatasetGroup) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDatasetGroup) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDatasetGroup) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDatasetGroup) # DescribeDatasetImportJob 描述使用该[CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)操作创建的数据集导入任务。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 除了列出 `CreateDatasetImportJob` 请求中提供的参数外，该操作还包括以下属性： + `CreationTime` + `LastModificationTime` + `DataSize` + `FieldStatistics` + `Status` + `Message` - 如果出现错误，则为错误的相关信息。 ## 请求语法 ``` { "DatasetImportJobArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [DatasetImportJobArn](#API_DescribeDatasetImportJob_RequestSyntax) ** 数据集导入作业的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "CreationTime": number, "DatasetArn": "string", "DatasetImportJobArn": "string", "DatasetImportJobName": "string", "DataSize": number, "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "EstimatedTimeRemainingInMinutes": number, "FieldStatistics": { "string" : { "Avg": number, "Count": number, "CountDistinct": number, "CountDistinctLong": number, "CountLong": number, "CountNan": number, "CountNanLong": number, "CountNull": number, "CountNullLong": number, "Max": "string", "Min": "string", "Stddev": number } }, "Format": "string", "GeolocationFormat": "string", "ImportMode": "string", "LastModificationTime": number, "Message": "string", "Status": "string", "TimestampFormat": "string", "TimeZone": "string", "UseGeolocationForTimeZone": boolean } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [CreationTime](#API_DescribeDatasetImportJob_ResponseSyntax) ** 数据集导入作业的创建时间。类型：时间戳 ** [DatasetArn](#API_DescribeDatasetImportJob_ResponseSyntax) ** 导入训练数据的数据集的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetImportJobArn](#API_DescribeDatasetImportJob_ResponseSyntax) ** 数据集导入作业的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetImportJobName](#API_DescribeDatasetImportJob_ResponseSyntax) ** 数据集导入作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [DataSize](#API_DescribeDatasetImportJob_ResponseSyntax) ** 导入作业完成后数据集的大小，以千兆字节（GB）为单位。类型：双精度 ** [DataSource](#API_DescribeDatasetImportJob_ResponseSyntax) ** 要导入的训练数据的位置以及 Amazon Forecast 可以代入的访问数据的 AWS Identity and Access Management (IAM) 角色。如果使用加密，则`DataSource`包含 AWS Key Management Service (KMS) 密钥。类型：[DataSource](API_DataSource.md) 对象 ** [EstimatedTimeRemainingInMinutes](#API_DescribeDatasetImportJob_ResponseSyntax) ** 完成数据集导入作业的估计剩余时间（分钟）。类型：长整型 ** [FieldStatistics](#API_DescribeDatasetImportJob_ResponseSyntax) ** 输入数据中每个字段的统计信息。类型：字符串到 [Statistics](API_Statistics.md) 对象的映射密钥长度限制：最大长度为 256。键模式：`^[a-zA-Z0-9\_]+$` ** [Format](#API_DescribeDatasetImportJob_ResponseSyntax) ** 导入数据的格式，CSV 或 PARQUET。类型：字符串长度限制：最大长度为 7。模式：`^CSV|PARQUET$` ** [GeolocationFormat](#API_DescribeDatasetImportJob_ResponseSyntax) ** 地理位置属性的格式。有效值：`"LAT_LONG"` 和 `"CC_POSTALCODE"`。类型：字符串长度约束：最大长度为 256。模式：`^[a-zA-Z0-9_]+$` ** [ImportMode](#API_DescribeDatasetImportJob_ResponseSyntax) ** 数据集导入作业的导入模式，FULL 或 INCREMENTAL。类型：字符串有效值：`FULL | INCREMENTAL` ** [LastModificationTime](#API_DescribeDatasetImportJob_ResponseSyntax) ** 上次修改资源的时间。时间戳取决于作业的状态： + `CREATE_PENDING` - `CreationTime`。 + `CREATE_IN_PROGRESS` - 当前时间戳。 + `CREATE_STOPPING` - 当前时间戳。 + `CREATE_STOPPED` - 当作业停止时。 + `ACTIVE` 或者 `CREATE_FAILED` - 当作业完成或失败时。类型：时间戳 ** [Message](#API_DescribeDatasetImportJob_ResponseSyntax) ** 如果出现错误，则为错误的信息消息。类型：字符串 ** [Status](#API_DescribeDatasetImportJob_ResponseSyntax) ** 数据集导入作业的状态。状态包括： + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` 类型：字符串长度约束：最大长度为 256。 ** [TimestampFormat](#API_DescribeDatasetImportJob_ResponseSyntax) ** 数据集中时间戳的格式。您指定的格式取决于创建数据集时 `DataFrequency` 指定的格式。支持以下格式。 + “yyyy-MM-dd” 适用于以下数据频率：Y、M、W 和 D + “yyyy-MM-dd HH: mm: ss” 适用于以下数据频率：H、30min、15min 和 1min；也可选择用于：Y、M、W 和 D 类型：字符串长度约束：最大长度为 256。模式：`^[a-zA-Z0-9\-\:\.\,\'\s]+$` ** [TimeZone](#API_DescribeDatasetImportJob_ResponseSyntax) ** 应用于数据集中每个项目的单一时区类型：字符串长度约束：最大长度为 256。模式：`^[a-zA-Z0-9\/\+\-\_]+$` ** [UseGeolocationForTimeZone](#API_DescribeDatasetImportJob_ResponseSyntax) ** `TimeZone` 是否自动从地理位置属性派生。类型：布尔值 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDatasetImportJob) # DescribeExplainability 描述使用 [CreateExplainability](API_CreateExplainability.md) 操作创建的可解释性资源。 **重要** Amazon Forecast 已不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "ExplainabilityArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ExplainabilityArn](#API_DescribeExplainability_RequestSyntax) ** 要描述的可解释性的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "CreationTime": number, "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "EnableVisualization": boolean, "EndDateTime": "string", "EstimatedTimeRemainingInMinutes": number, "ExplainabilityArn": "string", "ExplainabilityConfig": { "TimePointGranularity": "string", "TimeSeriesGranularity": "string" }, "ExplainabilityName": "string", "LastModificationTime": number, "Message": "string", "ResourceArn": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "StartDateTime": "string", "Status": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [CreationTime](#API_DescribeExplainability_ResponseSyntax) ** 创建可解释性资源的时间。类型：时间戳 ** [DataSource](#API_DescribeExplainability_ResponseSyntax) ** 您的数据来源、允许 Amazon Forecast 访问数据的 AWS Identity and Access Management (IAM) 角色以及可选的 AWS Key Management Service (KMS) 密钥。类型：[DataSource](API_DataSource.md) 对象 ** [EnableVisualization](#API_DescribeExplainability_ResponseSyntax) ** 是否启用了可解释性资源的可视化。类型：布尔值 ** [EndDateTime](#API_DescribeExplainability_ResponseSyntax) ** 如果设置 `TimePointGranularity` 为 `SPECIFIC`，则为可解释性中的最后一个时间点。类型：字符串长度限制：最大长度为 19。模式：`^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` ** [EstimatedTimeRemainingInMinutes](#API_DescribeExplainability_ResponseSyntax) ** 完成 [CreateExplainability](API_CreateExplainability.md) 作业的估计剩余时间（分钟）。类型：长整型 ** [ExplainabilityArn](#API_DescribeExplainability_ResponseSyntax) ** 可解释性的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ExplainabilityConfig](#API_DescribeExplainability_ResponseSyntax) ** 定义可解释性的时间序列粒度和时间点的配置设置。类型：[ExplainabilityConfig](API_ExplainabilityConfig.md) 对象 ** [ExplainabilityName](#API_DescribeExplainability_ResponseSyntax) ** 可解释性的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [LastModificationTime](#API_DescribeExplainability_ResponseSyntax) ** 上次修改资源的时间。时间戳取决于作业的状态： + `CREATE_PENDING` - `CreationTime`。 + `CREATE_IN_PROGRESS` - 当前时间戳。 + `CREATE_STOPPING` - 当前时间戳。 + `CREATE_STOPPED` - 当作业停止时。 + `ACTIVE` 或者 `CREATE_FAILED` - 当作业完成或失败时。类型：时间戳 ** [Message](#API_DescribeExplainability_ResponseSyntax) ** 如果出现错误，则为一条说明错误的消息。类型：字符串 ** [ResourceArn](#API_DescribeExplainability_ResponseSyntax) ** 用于创建可解释性资源的预测器或预测的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [Schema](#API_DescribeExplainability_ResponseSyntax) ** 定义数据集的字段。类型：[Schema](API_Schema.md) 对象 ** [StartDateTime](#API_DescribeExplainability_ResponseSyntax) ** 如果设置 `TimePointGranularity` 为 `SPECIFIC`，则为可解释性中的第一个时间点。类型：字符串长度限制：最大长度为 19。模式：`^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` ** [Status](#API_DescribeExplainability_ResponseSyntax) ** 可解释性资源的状态。状态包括： + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 类型：字符串长度约束：最大长度为 256。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeExplainability) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeExplainability) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeExplainability) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeExplainability) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeExplainability) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeExplainability) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeExplainability) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeExplainability) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeExplainability) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeExplainability) # DescribeExplainabilityExport 描述使用 [CreateExplainabilityExport](API_CreateExplainabilityExport.md) 操作创建的可解释性导出。 ## 请求语法 ``` { "ExplainabilityExportArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ExplainabilityExportArn](#API_DescribeExplainabilityExport_RequestSyntax) ** 可解释性导出的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ExplainabilityArn": "string", "ExplainabilityExportArn": "string", "ExplainabilityExportName": "string", "Format": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [CreationTime](#API_DescribeExplainabilityExport_ResponseSyntax) ** 创建可解释性导出的时间。类型：时间戳 ** [Destination](#API_DescribeExplainabilityExport_ResponseSyntax) ** 导出作业的目的地。提供 S3 路径、允许 Amazon Forecast 访问该位置的 AWS Identity and Access Management (IAM) 角色和 AWS Key Management Service (KMS) 密钥（可选）。类型：[DataDestination](API_DataDestination.md) 对象 ** [ExplainabilityArn](#API_DescribeExplainabilityExport_ResponseSyntax) ** 可解释性导出的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ExplainabilityExportArn](#API_DescribeExplainabilityExport_ResponseSyntax) ** 可解释性导出的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ExplainabilityExportName](#API_DescribeExplainabilityExport_ResponseSyntax) ** 可解释性导出的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [Format](#API_DescribeExplainabilityExport_ResponseSyntax) ** 导出数据的格式，CSV 或 PARQUET。类型：字符串长度限制：最大长度为 7。模式：`^CSV|PARQUET$` ** [LastModificationTime](#API_DescribeExplainabilityExport_ResponseSyntax) ** 上次修改资源的时间。时间戳取决于作业的状态： + `CREATE_PENDING` - `CreationTime`。 + `CREATE_IN_PROGRESS` - 当前时间戳。 + `CREATE_STOPPING` - 当前时间戳。 + `CREATE_STOPPED` - 当作业停止时。 + `ACTIVE` 或者 `CREATE_FAILED` - 当作业完成或失败时。类型：时间戳 ** [Message](#API_DescribeExplainabilityExport_ResponseSyntax) ** 有关导出期间发生的任何错误的信息。类型：字符串 ** [Status](#API_DescribeExplainabilityExport_ResponseSyntax) ** 可解释性导出的状态。状态包括： + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 类型：字符串长度约束：最大长度为 256。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeExplainabilityExport) # DescribeForecast 描述使用 [CreateForecast](API_CreateForecast.md) 操作创建的预测。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 除了列出 `CreateForecast` 请求中提供的属性外，该操作还列出了以下属性： + `DatasetGroupArn` - 提供训练数据的数据集组。 + `CreationTime` + `LastModificationTime` + `Status` + `Message` - 如果出现错误，则为错误相关的信息。 ## 请求语法 ``` { "ForecastArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ForecastArn](#API_DescribeForecast_RequestSyntax) ** 预测的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "CreationTime": number, "DatasetGroupArn": "string", "EstimatedTimeRemainingInMinutes": number, "ForecastArn": "string", "ForecastName": "string", "ForecastTypes": [ "string" ], "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "Status": "string", "TimeSeriesSelector": { "TimeSeriesIdentifiers": { "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] } } } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [CreationTime](#API_DescribeForecast_ResponseSyntax) ** 预测创建任务的创建时间。类型：时间戳 ** [DatasetGroupArn](#API_DescribeForecast_ResponseSyntax) ** 提供用于训练预测器的数据的数据集组的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [EstimatedTimeRemainingInMinutes](#API_DescribeForecast_ResponseSyntax) ** 完成预测作业的估计剩余时间（分钟）。类型：长整型 ** [ForecastArn](#API_DescribeForecast_ResponseSyntax) ** 请求中指定的预测 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ForecastName](#API_DescribeForecast_ResponseSyntax) ** 预测的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [ForecastTypes](#API_DescribeForecast_ResponseSyntax) ** 生成概率预测的分位数。类型：字符串数组数组成员：最少 1 项。最多 20 项。长度限制：最小长度为 2。最大长度为 4。模式：`(^0?\.\d\d?$|^mean$)` ** [LastModificationTime](#API_DescribeForecast_ResponseSyntax) ** 上次修改资源的时间。时间戳取决于作业的状态： + `CREATE_PENDING` - `CreationTime`。 + `CREATE_IN_PROGRESS` - 当前时间戳。 + `CREATE_STOPPING` - 当前时间戳。 + `CREATE_STOPPED` - 当作业停止时。 + `ACTIVE` 或者 `CREATE_FAILED` - 当作业完成或失败时。类型：时间戳 ** [Message](#API_DescribeForecast_ResponseSyntax) ** 如果出现错误，则为错误的信息消息。类型：字符串 ** [PredictorArn](#API_DescribeForecast_ResponseSyntax) ** 用于生成预测的预测器的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [Status](#API_DescribeForecast_ResponseSyntax) ** 预测的状态。状态包括： + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 在查询或导出预测之前，预测的 `Status` 必须为 `ACTIVE`。类型：字符串长度约束：最大长度为 256。模式：`^[a-zA-Z0-9\_]+$` ** [TimeSeriesSelector](#API_DescribeForecast_ResponseSyntax) ** 要包含在预测中的时间序列。类型：[TimeSeriesSelector](API_TimeSeriesSelector.md) 对象 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeForecast) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeForecast) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeForecast) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeForecast) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeForecast) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeForecast) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeForecast) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeForecast) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeForecast) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeForecast) # DescribeForecastExportJob 描述使用 [CreateForecastExportJob](API_CreateForecastExportJob.md) 操作创建的预测导出作业。除了列出用户在 `CreateForecastExportJob` 请求中提供的属性外，该操作还列出了以下属性： + `CreationTime` + `LastModificationTime` + `Status` + `Message` - 如果出现错误，则为错误相关的信息。 ## 请求语法 ``` { "ForecastExportJobArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ForecastExportJobArn](#API_DescribeForecastExportJob_RequestSyntax) ** 预测导出作业的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ForecastArn": "string", "ForecastExportJobArn": "string", "ForecastExportJobName": "string", "Format": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [CreationTime](#API_DescribeForecastExportJob_ResponseSyntax) ** 创建预测导出作业的时间。类型：时间戳 ** [Destination](#API_DescribeForecastExportJob_ResponseSyntax) ** 导出预测的 Amazon Simple Storage Service（Amazon S3）存储桶的路径。类型：[DataDestination](API_DataDestination.md) 对象 ** [ForecastArn](#API_DescribeForecastExportJob_ResponseSyntax) ** 导出预测的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ForecastExportJobArn](#API_DescribeForecastExportJob_ResponseSyntax) ** 预测导出作业的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ForecastExportJobName](#API_DescribeForecastExportJob_ResponseSyntax) ** 预测导出作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [Format](#API_DescribeForecastExportJob_ResponseSyntax) ** 导出数据的格式，CSV 或 PARQUET。类型：字符串长度限制：最大长度为 7。模式：`^CSV|PARQUET$` ** [LastModificationTime](#API_DescribeForecastExportJob_ResponseSyntax) ** 上次修改资源的时间。时间戳取决于作业的状态： + `CREATE_PENDING` - `CreationTime`。 + `CREATE_IN_PROGRESS` - 当前时间戳。 + `CREATE_STOPPING` - 当前时间戳。 + `CREATE_STOPPED` - 当作业停止时。 + `ACTIVE` 或者 `CREATE_FAILED` - 当作业完成或失败时。类型：时间戳 ** [Message](#API_DescribeForecastExportJob_ResponseSyntax) ** 如果出现错误，则为错误的信息消息。类型：字符串 ** [Status](#API_DescribeForecastExportJob_ResponseSyntax) ** 预测导出作业的状态。状态包括： + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 预测导出作业的 `Status` 必须为 `ACTIVE`，然后才能访问 S3 存储桶中的预测。类型：字符串长度约束：最大长度为 256。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeForecastExportJob) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeForecastExportJob) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeForecastExportJob) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeForecastExportJob) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeForecastExportJob) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeForecastExportJob) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeForecastExportJob) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeForecastExportJob) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeForecastExportJob) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeForecastExportJob) # DescribeMonitor 描述监控资源。除了列出 [CreateMonitor](API_CreateMonitor.md) 请求中提供的属性外，该操作还列出了以下属性： + `Baseline` + `CreationTime` + `LastEvaluationTime` + `LastEvaluationState` + `LastModificationTime` + `Message` + `Status` **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "MonitorArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [MonitorArn](#API_DescribeMonitor_RequestSyntax) ** 要描述的监控资源的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "Baseline": { "PredictorBaseline": { "BaselineMetrics": [ { "Name": "string", "Value": number } ] } }, "CreationTime": number, "EstimatedEvaluationTimeRemainingInMinutes": number, "LastEvaluationState": "string", "LastEvaluationTime": number, "LastModificationTime": number, "Message": "string", "MonitorArn": "string", "MonitorName": "string", "ResourceArn": "string", "Status": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Baseline](#API_DescribeMonitor_ResponseSyntax) ** 可用于比较的基准的指标。使用这些值可以解释自动预测器的监控结果。类型：[Baseline](API_Baseline.md) 对象 ** [CreationTime](#API_DescribeMonitor_ResponseSyntax) ** 创建监控资源时的时间戳。类型：时间戳 ** [EstimatedEvaluationTimeRemainingInMinutes](#API_DescribeMonitor_ResponseSyntax) ** 监控资源完成其当前评估之前的估计剩余时间（分钟）。类型：长整型 ** [LastEvaluationState](#API_DescribeMonitor_ResponseSyntax) ** 监控器最新评估的状态。类型：字符串长度约束：最大长度为 256。 ** [LastEvaluationTime](#API_DescribeMonitor_ResponseSyntax) ** 监控器完成的最新评估的时间戳。类型：时间戳 ** [LastModificationTime](#API_DescribeMonitor_ResponseSyntax) ** 对监控器进行最新修改的时间戳。类型：时间戳 ** [Message](#API_DescribeMonitor_ResponseSyntax) ** 监控器的错误消息（如有）。类型：字符串 ** [MonitorArn](#API_DescribeMonitor_ResponseSyntax) ** 描述的监控资源的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [MonitorName](#API_DescribeMonitor_ResponseSyntax) ** 监控器的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [ResourceArn](#API_DescribeMonitor_ResponseSyntax) ** 监控的自动预测器的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [Status](#API_DescribeMonitor_ResponseSyntax) ** 监控资源的状态。类型：字符串长度约束：最大长度为 256。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeMonitor) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeMonitor) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeMonitor) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeMonitor) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeMonitor) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeMonitor) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeMonitor) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeMonitor) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeMonitor) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeMonitor) # DescribePredictor **注意** 此操作仅对使用 CreatePredictor创建的传统预测变量有效。如果您没有使用传统预测器，请使用 [DescribeAutoPredictor](API_DescribeAutoPredictor.md)。描述使用 [CreatePredictor](API_CreatePredictor.md) 操作创建的预测器。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 除了列出 `CreatePredictor` 请求中提供的属性外，该操作还列出了以下属性： + `DatasetImportJobArns` - 用于导入训练数据的数据集导入作业。 + `AutoMLAlgorithmArns` - 如果执行了 AutoML，则为已评估的算法。 + `CreationTime` + `LastModificationTime` + `Status` + `Message` - 如果出现错误，则为错误相关的信息。 ## 请求语法 ``` { "PredictorArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [PredictorArn](#API_DescribePredictor_RequestSyntax) ** 您要获取相关信息的预测器的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "AlgorithmArn": "string", "AutoMLAlgorithmArns": [ "string" ], "AutoMLOverrideStrategy": "string", "CreationTime": number, "DatasetImportJobArns": [ "string" ], "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "EstimatedTimeRemainingInMinutes": number, "EvaluationParameters": { "BackTestWindowOffset": number, "NumberOfBacktestWindows": number }, "FeaturizationConfig": { "Featurizations": [ { "AttributeName": "string", "FeaturizationPipeline": [ { "FeaturizationMethodName": "string", "FeaturizationMethodParameters": { "string" : "string" } } ] } ], "ForecastDimensions": [ "string" ], "ForecastFrequency": "string" }, "ForecastHorizon": number, "ForecastTypes": [ "string" ], "HPOConfig": { "ParameterRanges": { "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": number, "MinValue": number, "Name": "string", "ScalingType": "string" } ], "IntegerParameterRanges": [ { "MaxValue": number, "MinValue": number, "Name": "string", "ScalingType": "string" } ] } }, "InputDataConfig": { "DatasetGroupArn": "string", "SupplementaryFeatures": [ { "Name": "string", "Value": "string" } ] }, "IsAutoPredictor": boolean, "LastModificationTime": number, "Message": "string", "OptimizationMetric": "string", "PerformAutoML": boolean, "PerformHPO": boolean, "PredictorArn": "string", "PredictorExecutionDetails": { "PredictorExecutions": [ { "AlgorithmArn": "string", "TestWindows": [ { "Message": "string", "Status": "string", "TestWindowEnd": number, "TestWindowStart": number } ] } ] }, "PredictorName": "string", "Status": "string", "TrainingParameters": { "string" : "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [AlgorithmArn](#API_DescribePredictor_ResponseSyntax) ** 用于模型训练的算法的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [AutoMLAlgorithmArns](#API_DescribePredictor_ResponseSyntax) ** 如果指定 `PerformAutoML`，则为所选算法的 ARN。类型：字符串数组长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [AutoMLOverrideStrategy](#API_DescribePredictor_ResponseSyntax) ** `LatencyOptimized` AutoML 覆盖策略仅在私有测试版中可用。请联系 Su AWS pport 或您的客户经理，详细了解访问权限。用于训练预测器的 AutoML 策略。除非指定 `LatencyOptimized`，否则 AutoML 策略会优化预测器的准确性。此参数仅对使用 AutoML 训练的预测器有效。类型：字符串有效值：`LatencyOptimized | AccuracyOptimized` ** [CreationTime](#API_DescribePredictor_ResponseSyntax) ** 创建模型训练任务的时间。类型：时间戳 ** [DatasetImportJobArns](#API_DescribePredictor_ResponseSyntax) ** 用于为预测器导入训练数据的数据集导入任务的数组。 ARNs 类型：字符串数组长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [EncryptionConfig](#API_DescribePredictor_ResponseSyntax) ** AWS Key Management Service (KMS) 密钥和 Amazon Forecast 可以代入的访问密钥的 AWS Identity and Access Management (IAM) 角色。类型：[EncryptionConfig](API_EncryptionConfig.md) 对象 ** [EstimatedTimeRemainingInMinutes](#API_DescribePredictor_ResponseSyntax) ** 完成预测器训练作业的估计剩余时间（分钟）。类型：长整型 ** [EvaluationParameters](#API_DescribePredictor_ResponseSyntax) ** 用于覆盖指定算法的默认评估参数。Amazon Forecast 通过将数据集拆分为训练数据和测试数据来评估预测器。评估参数定义了如何执行拆分和迭代次数。类型：[EvaluationParameters](API_EvaluationParameters.md) 对象 ** [FeaturizationConfig](#API_DescribePredictor_ResponseSyntax) ** 特征化配置。类型：[FeaturizationConfig](API_FeaturizationConfig.md) 对象 ** [ForecastHorizon](#API_DescribePredictor_ResponseSyntax) ** 预测的时间步数。预测范围也称为预测长度。类型：整数 ** [ForecastTypes](#API_DescribePredictor_ResponseSyntax) ** 预测器训练期间使用的预测类型。默认值为 `["0.1","0.5","0.9"]` 类型：字符串数组数组成员：最少 1 项。最多 20 项。长度限制：最小长度为 2。最大长度为 4。模式：`(^0?\.\d\d?$|^mean$)` ** [HPOConfig](#API_DescribePredictor_ResponseSyntax) ** 超参数覆盖算法的值。类型：[HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) 对象 ** [InputDataConfig](#API_DescribePredictor_ResponseSyntax) ** 描述包含要用于训练预测器的数据的数据集组。类型：[InputDataConfig](API_InputDataConfig.md) 对象 ** [IsAutoPredictor](#API_DescribePredictor_ResponseSyntax) ** 预测器是否通过 [CreateAutoPredictor](API_CreateAutoPredictor.md) 创建。类型：布尔值 ** [LastModificationTime](#API_DescribePredictor_ResponseSyntax) ** 上次修改资源的时间。时间戳取决于作业的状态： + `CREATE_PENDING` - `CreationTime`。 + `CREATE_IN_PROGRESS` - 当前时间戳。 + `CREATE_STOPPING` - 当前时间戳。 + `CREATE_STOPPED` - 当作业停止时。 + `ACTIVE` 或者 `CREATE_FAILED` - 当作业完成或失败时。类型：时间戳 ** [Message](#API_DescribePredictor_ResponseSyntax) ** 如果出现错误，则为错误的信息消息。类型：字符串 ** [OptimizationMetric](#API_DescribePredictor_ResponseSyntax) ** 用于优化预测器的准确性指标。类型：字符串有效值：`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` ** [PerformAutoML](#API_DescribePredictor_ResponseSyntax) ** 预测器是否设置为执行 AutoML。类型：布尔值 ** [PerformHPO](#API_DescribePredictor_ResponseSyntax) ** 预测器是否设置为执行超参数优化（HPO）。类型：布尔值 ** [PredictorArn](#API_DescribePredictor_ResponseSyntax) ** 预测器的 ARN。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [PredictorExecutionDetails](#API_DescribePredictor_ResponseSyntax) ** 为评估预测器准确性而进行的回测的状态和结果详情。在调用 [CreatePredictor](API_CreatePredictor.md) 操作时，可以指定要执行的回测次数。类型：[PredictorExecutionDetails](API_PredictorExecutionDetails.md) 对象 ** [PredictorName](#API_DescribePredictor_ResponseSyntax) ** 预测器的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [Status](#API_DescribePredictor_ResponseSyntax) ** 预测器的状态。状态包括： + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` 在使用预测器创建预测之前，预测器的 `Status` 必须为 `ACTIVE`。类型：字符串长度约束：最大长度为 256。 ** [TrainingParameters](#API_DescribePredictor_ResponseSyntax) ** 模型训练期间选择的默认训练参数或覆盖。运行 AutoML 或选择带 CNN-QR 或 DeepAR\$1 的 HPO 时，将返回所选超参数的优化值。有关更多信息，请参阅 [Amazon Forecast 算法](aws-forecast-choosing-recipes.md)。类型：字符串到字符串映射映射条目：最低 0 项。最多 100 个项目。密钥长度限制：最大长度为 256。键模式：`^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$` 值长度限制：最大长度为 256。值模式：`^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$` ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribePredictor) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribePredictor) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribePredictor) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribePredictor) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribePredictor) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribePredictor) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribePredictor) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribePredictor) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribePredictor) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribePredictor) # DescribePredictorBacktestExportJob 描述使用 [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md) 操作创建的预测器回测导出作业。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 除了列出用户在 `CreatePredictorBacktestExportJob` 请求中提供的属性外，该操作还列出了以下属性： + `CreationTime` + `LastModificationTime` + `Status` + `Message`（如果发生错误） ## 请求语法 ``` { "PredictorBacktestExportJobArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [PredictorBacktestExportJobArn](#API_DescribePredictorBacktestExportJob_RequestSyntax) ** 预测器回测导出作业的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "PredictorBacktestExportJobArn": "string", "PredictorBacktestExportJobName": "string", "Status": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [CreationTime](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 当创建预测器回测导出作业时。类型：时间戳 ** [Destination](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 导出作业的目的地。提供 S3 路径、允许 Amazon Forecast 访问该位置的 AWS Identity and Access Management (IAM) 角色和 AWS Key Management Service (KMS) 密钥（可选）。类型：[DataDestination](API_DataDestination.md) 对象 ** [Format](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 导出数据的格式，CSV 或 PARQUET。类型：字符串长度限制：最大长度为 7。模式：`^CSV|PARQUET$` ** [LastModificationTime](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 上次修改资源的时间。时间戳取决于作业的状态： + `CREATE_PENDING` - `CreationTime`。 + `CREATE_IN_PROGRESS` - 当前时间戳。 + `CREATE_STOPPING` - 当前时间戳。 + `CREATE_STOPPED` - 当作业停止时。 + `ACTIVE` 或者 `CREATE_FAILED` - 当作业完成或失败时。类型：时间戳 ** [Message](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 有关回测导出期间可能发生的任何错误的信息。类型：字符串 ** [PredictorArn](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 预测器的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [PredictorBacktestExportJobArn](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 预测器回测导出作业的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [PredictorBacktestExportJobName](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 预测器回测导出作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [Status](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 预测器回测导出作业的状态。状态包括： + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 类型：字符串长度约束：最大长度为 256。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) # DescribeWhatIfAnalysis 描述使用 [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) 操作创建的假设分析。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 除了列出 `CreateWhatIfAnalysis` 请求中提供的属性外，该操作还列出了以下属性： + `CreationTime` + `LastModificationTime` + `Message` - 如果出现错误，则为错误相关的信息。 + `Status` ## 请求语法 ``` { "WhatIfAnalysisArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [WhatIfAnalysisArn](#API_DescribeWhatIfAnalysis_RequestSyntax) ** 您感兴趣的假设分析的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "CreationTime": number, "EstimatedTimeRemainingInMinutes": number, "ForecastArn": "string", "LastModificationTime": number, "Message": "string", "Status": "string", "TimeSeriesSelector": { "TimeSeriesIdentifiers": { "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] } } }, "WhatIfAnalysisArn": "string", "WhatIfAnalysisName": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [CreationTime](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** 假设分析的创建时间。类型：时间戳 ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** 完成假设分析的大致剩余时间（分钟）。类型：长整型 ** [ForecastArn](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** 假设分析预测的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [LastModificationTime](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** 上次修改资源的时间。时间戳取决于作业的状态： + `CREATE_PENDING` - `CreationTime`。 + `CREATE_IN_PROGRESS` - 当前时间戳。 + `CREATE_STOPPING` - 当前时间戳。 + `CREATE_STOPPED` - 当作业停止时。 + `ACTIVE` 或者 `CREATE_FAILED` - 当作业完成或失败时。类型：时间戳 ** [Message](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** 如果出现错误，则为错误的信息消息。类型：字符串 ** [Status](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** 假设分析的状态。状态包括： + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 假设分析的 `Status` 必须为 `ACTIVE`，您才能访问分析。类型：字符串长度约束：最大长度为 256。模式：`^[a-zA-Z0-9\_]+$` ** [TimeSeriesSelector](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** 定义用于在 `TimeSeriesIdentifiers` 对象中创建预测的时间序列集。 `TimeSeriesIdentifiers` 对象需要具备以下信息： + `DataSource` + `Format` + `Schema` 类型：[TimeSeriesSelector](API_TimeSeriesSelector.md) 对象 ** [WhatIfAnalysisArn](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** 假设分析的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfAnalysisName](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** 假设分析的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfAnalysis) # DescribeWhatIfForecast 描述使用 [CreateWhatIfForecast](API_CreateWhatIfForecast.md) 操作创建的假设分析预测。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 除了列出 `CreateWhatIfForecast` 请求中提供的属性外，该操作还列出了以下属性： + `CreationTime` + `LastModificationTime` + `Message` - 如果出现错误，则为错误相关的信息。 + `Status` ## 请求语法 ``` { "WhatIfForecastArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [WhatIfForecastArn](#API_DescribeWhatIfForecast_RequestSyntax) ** 您感兴趣的假设分析预测的 Amazon 资源名称（ARN）。类型：字符串长度限制：最大长度为 300。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "CreationTime": number, "EstimatedTimeRemainingInMinutes": number, "ForecastTypes": [ "string" ], "LastModificationTime": number, "Message": "string", "Status": "string", "TimeSeriesReplacementsDataSource": { "Format": "string", "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" }, "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "TimestampFormat": "string" }, "TimeSeriesTransformations": [ { "Action": { "AttributeName": "string", "Operation": "string", "Value": number }, "TimeSeriesConditions": [ { "AttributeName": "string", "AttributeValue": "string", "Condition": "string" } ] } ], "WhatIfAnalysisArn": "string", "WhatIfForecastArn": "string", "WhatIfForecastName": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [CreationTime](#API_DescribeWhatIfForecast_ResponseSyntax) ** 假设分析预测的创建时间。类型：时间戳 ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfForecast_ResponseSyntax) ** 完成假设分析预测的大致剩余时间（分钟）。类型：长整型 ** [ForecastTypes](#API_DescribeWhatIfForecast_ResponseSyntax) ** 生成概率预测的分位数。在 [CreateWhatIfForecast](API_CreateWhatIfForecast.md) 操作中，您最多可以为每个假设分析预测指定五个分位数。如果您未指定分位数，则默认值为 `["0.1", "0.5", "0.9"]`。类型：字符串数组数组成员：最少 1 项。最多 20 项。长度限制：最小长度为 2。最大长度为 4。模式：`(^0?\.\d\d?$|^mean$)` ** [LastModificationTime](#API_DescribeWhatIfForecast_ResponseSyntax) ** 上次修改资源的时间。时间戳取决于作业的状态： + `CREATE_PENDING` - `CreationTime`。 + `CREATE_IN_PROGRESS` - 当前时间戳。 + `CREATE_STOPPING` - 当前时间戳。 + `CREATE_STOPPED` - 当作业停止时。 + `ACTIVE` 或者 `CREATE_FAILED` - 当作业完成或失败时。类型：时间戳 ** [Message](#API_DescribeWhatIfForecast_ResponseSyntax) ** 如果出现错误，则为错误的信息消息。类型：字符串 ** [Status](#API_DescribeWhatIfForecast_ResponseSyntax) ** 假设分析预测的状态。状态包括： + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 在访问预测之前，假设分析预测的 `Status` 必须为 `ACTIVE`。类型：字符串长度约束：最大长度为 256。模式：`^[a-zA-Z0-9\_]+$` ** [TimeSeriesReplacementsDataSource](#API_DescribeWhatIfForecast_ResponseSyntax) ** 描述替换时间序列的 `S3Config`、`Schema` 和 `Format` 元素的数组。类型：[TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) 对象 ** [TimeSeriesTransformations](#API_DescribeWhatIfForecast_ResponseSyntax) ** `Action` 和 `TimeSeriesConditions` 元素的数组，用于描述对哪些时间序列进行了转换。类型：[TimeSeriesTransformation](API_TimeSeriesTransformation.md) 对象数组数组成员：最少 0 个物品。最多 30 项。 ** [WhatIfAnalysisArn](#API_DescribeWhatIfForecast_ResponseSyntax) ** 包含该预测的假设分析的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfForecastArn](#API_DescribeWhatIfForecast_ResponseSyntax) ** 假设分析预测的 Amazon 资源名称（ARN）。类型：字符串长度限制：最大长度为 300。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfForecastName](#API_DescribeWhatIfForecast_ResponseSyntax) ** 假设分析预测的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfForecast) # DescribeWhatIfForecastExport 描述使用 [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) 操作创建的假设分析预测导出。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 除了列出 `CreateWhatIfForecastExport` 请求中提供的属性外，该操作还列出了以下属性： + `CreationTime` + `LastModificationTime` + `Message` - 如果出现错误，则为错误相关的信息。 + `Status` ## 请求语法 ``` { "WhatIfForecastExportArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [WhatIfForecastExportArn](#API_DescribeWhatIfForecastExport_RequestSyntax) ** 您感兴趣的假设分析预测导出的 Amazon 资源名称（ARN）。类型：字符串长度限制：最大长度为 300。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "EstimatedTimeRemainingInMinutes": number, "Format": "string", "LastModificationTime": number, "Message": "string", "Status": "string", "WhatIfForecastArns": [ "string" ], "WhatIfForecastExportArn": "string", "WhatIfForecastExportName": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [CreationTime](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** 创建假设分析预测导出的时间。类型：时间戳 ** [Destination](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** 导出作业的目的地。提供 S3 路径、允许 Amazon Forecast 访问该位置的 AWS Identity and Access Management (IAM) 角色和 AWS Key Management Service (KMS) 密钥（可选）。类型：[DataDestination](API_DataDestination.md) 对象 ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** 完成假设分析预测导出的大致剩余时间（分钟）。类型：长整型 ** [Format](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** 导出数据的格式，CSV 或 PARQUET。类型：字符串长度限制：最大长度为 7。模式：`^CSV|PARQUET$` ** [LastModificationTime](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** 上次修改资源的时间。时间戳取决于作业的状态： + `CREATE_PENDING` - `CreationTime`。 + `CREATE_IN_PROGRESS` - 当前时间戳。 + `CREATE_STOPPING` - 当前时间戳。 + `CREATE_STOPPED` - 当作业停止时。 + `ACTIVE` 或者 `CREATE_FAILED` - 当作业完成或失败时。类型：时间戳 ** [Message](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** 如果出现错误，则为错误的信息消息。类型：字符串 ** [Status](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** 假设分析预测的状态。状态包括： + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 假设分析预测导出的 `Status` 必须为 `ACTIVE`，然后才能访问预测导出。类型：字符串长度约束：最大长度为 256。 ** [WhatIfForecastArns](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** 一组 Amazon 资源名称 (ARNs)，代表此资源中导出的所有假设预测。类型：字符串数组长度限制：最大长度为 300。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfForecastExportArn](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** 假设分析预测导出的 Amazon 资源名称（ARN）。类型：字符串长度限制：最大长度为 300。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfForecastExportName](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** 假设分析预测导出的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfForecastExport) # GetAccuracyMetrics 提供通过 [CreatePredictor](API_CreatePredictor.md) 操作训练的模型准确性的指标。使用指标查看模型的性能并决定是否使用预测器生成预测。有关更多信息，请参阅[预测器指标](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html)。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 该操作生成评估的每个回测窗口的指标。回测窗口（`NumberOfBacktestWindows`）的数量使用 [EvaluationParameters](API_EvaluationParameters.md) 对象指定，该对象可选择性地包含在 `CreatePredictor` 请求中。如果 `NumberOfBacktestWindows` 未指定，则数量默认为 1。 `filling` 方法的参数决定哪些项目对指标有影响。如果想让所有项目都产生影响，则指定 `zero`。如果只想让在评估范围内有完整数据的项目产生影响，则指定 `nan`。有关更多信息，请参阅 [FeaturizationMethod](API_FeaturizationMethod.md)。 **注意** 在获得准确性指标之前，预测器的 `Status` 必须为 `ACTIVE`，表示训练已完成。使用 [DescribePredictor](API_DescribePredictor.md) 操作获取状态。 ## 请求语法 ``` { "PredictorArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [PredictorArn](#API_GetAccuracyMetrics_RequestSyntax) ** 要获取指标的预测器的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "AutoMLOverrideStrategy": "string", "IsAutoPredictor": boolean, "OptimizationMetric": "string", "PredictorEvaluationResults": [ { "AlgorithmArn": "string", "TestWindows": [ { "EvaluationType": "string", "ItemCount": number, "Metrics": { "AverageWeightedQuantileLoss": number, "ErrorMetrics": [ { "ForecastType": "string", "MAPE": number, "MASE": number, "RMSE": number, "WAPE": number } ], "RMSE": number, "WeightedQuantileLosses": [ { "LossValue": number, "Quantile": number } ] }, "TestWindowEnd": number, "TestWindowStart": number } ] } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [AutoMLOverrideStrategy](#API_GetAccuracyMetrics_ResponseSyntax) ** `LatencyOptimized` AutoML 覆盖策略仅在私有测试版中可用。请联系 Su AWS pport 或您的客户经理，详细了解访问权限。用于训练预测器的 AutoML 策略。除非指定 `LatencyOptimized`，否则 AutoML 策略会优化预测器的准确性。此参数仅对使用 AutoML 训练的预测器有效。类型：字符串有效值：`LatencyOptimized | AccuracyOptimized` ** [IsAutoPredictor](#API_GetAccuracyMetrics_ResponseSyntax) ** 预测器是否通过 [CreateAutoPredictor](API_CreateAutoPredictor.md) 创建。类型：布尔值 ** [OptimizationMetric](#API_GetAccuracyMetrics_ResponseSyntax) ** 用于优化预测器的准确性指标。类型：字符串有效值：`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` ** [PredictorEvaluationResults](#API_GetAccuracyMetrics_ResponseSyntax) ** 评估预测器的结果数组。类型：[EvaluationResult](API_EvaluationResult.md) 对象数组 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/GetAccuracyMetrics) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/GetAccuracyMetrics) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/GetAccuracyMetrics) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/GetAccuracyMetrics) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/GetAccuracyMetrics) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/GetAccuracyMetrics) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/GetAccuracyMetrics) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/GetAccuracyMetrics) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/GetAccuracyMetrics) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/GetAccuracyMetrics) # ListDatasetGroups 返回使用该[CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)操作创建的数据集组的列表。对于每个数据集组，该操作返回其属性摘要，包括 Amazon 资源名称（ARN）。您可以通过将数据集组 ARN 与操作配合使用来检索完整的属性集。[DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) **重要** Amazon Forecast 已不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "MaxResults": number, "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [MaxResults](#API_ListDatasetGroups_RequestSyntax) ** 响应中需返回的项目数。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [NextToken](#API_ListDatasetGroups_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 `NextToken`。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` 必需：否 ## 响应语法 ``` { "DatasetGroups": [ { "CreationTime": number, "DatasetGroupArn": "string", "DatasetGroupName": "string", "LastModificationTime": number } ], "NextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [DatasetGroups](#API_ListDatasetGroups_ResponseSyntax) ** 汇总每个数据集组属性的对象数组。类型：[DatasetGroupSummary](API_DatasetGroupSummary.md) 对象数组 ** [NextToken](#API_ListDatasetGroups_ResponseSyntax) ** 如果响应被截断，Amazon Forecast 将返回该令牌。要检索下一个结果集，请在下一个请求中使用令牌。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` ## 错误 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListDatasetGroups) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasetGroups) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasetGroups) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasetGroups) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasetGroups) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasetGroups) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasetGroups) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasetGroups) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasetGroups) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasetGroups) # ListDatasetImportJobs 返回使用该[CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)操作创建的数据集导入任务的列表。对于每个导入作业，该操作返回其属性摘要，包括 Amazon 资源名称（ARN）。您可以通过在操作中使用 ARN 来检索完整的属性集。[DescribeDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html)您可以通过提供[筛选条件](https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html)对象数组，来筛选列表。 ## 请求语法 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Filters](#API_ListDatasetImportJobs_RequestSyntax) ** 筛选条件数组。对于每个筛选条件，都要提供一个条件和一个匹配语句。条件为 `IS` 或 `IS_NOT`，指定包括还是从列表中排除与语句匹配的数据集。匹配语句包含一个键和一个值。 **筛选条件属性** + `Condition` - 适用的条件。有效值为 `IS` 和 `IS_NOT`。要包括与该语句匹配的数据集，请指定 `IS`。要排除匹配的数据集，请指定 `IS_NOT`。 + `Key` - 要筛选的参数的名称。有效值为 `DatasetArn` 和 `Status`。 + `Value` - 要匹配的值。例如，要列出状态为“活动”的所有数据集导入作业，请指定以下筛选条件： `"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]` 类型：[Filter](API_Filter.md) 对象数组必需：否 ** [MaxResults](#API_ListDatasetImportJobs_RequestSyntax) ** 响应中需返回的项目数。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [NextToken](#API_ListDatasetImportJobs_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 `NextToken`。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` 必需：否 ## 响应语法 ``` { "DatasetImportJobs": [ { "CreationTime": number, "DatasetImportJobArn": "string", "DatasetImportJobName": "string", "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ImportMode": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ], "NextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [DatasetImportJobs](#API_ListDatasetImportJobs_ResponseSyntax) ** 汇总每个数据集导入作业属性的对象数组。类型：[DatasetImportJobSummary](API_DatasetImportJobSummary.md) 对象数组 ** [NextToken](#API_ListDatasetImportJobs_ResponseSyntax) ** 如果响应被截断，Amazon Forecast 将返回该令牌。要检索下一个结果集，请在下一个请求中使用令牌。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListDatasetImportJobs) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasetImportJobs) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasetImportJobs) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasetImportJobs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasetImportJobs) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasetImportJobs) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasetImportJobs) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasetImportJobs) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasetImportJobs) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasetImportJobs) # ListDatasets 返回使用该[CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)操作创建的数据集的列表。对于每个数据集，返回其属性摘要，包括 Amazon 资源名称（ARN）。要检索完整的属性集，将 ARN 与 [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) 操作结合使用。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "MaxResults": number, "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [MaxResults](#API_ListDatasets_RequestSyntax) ** 响应中需返回的项目数。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [NextToken](#API_ListDatasets_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 `NextToken`。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` 必需：否 ## 响应语法 ``` { "Datasets": [ { "CreationTime": number, "DatasetArn": "string", "DatasetName": "string", "DatasetType": "string", "Domain": "string", "LastModificationTime": number } ], "NextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Datasets](#API_ListDatasets_ResponseSyntax) ** 汇总每个数据集属性的对象数组。类型：[DatasetSummary](API_DatasetSummary.md) 对象数组 ** [NextToken](#API_ListDatasets_ResponseSyntax) ** 如果响应被截断，Amazon Forecast 将返回该令牌。要检索下一个结果集，请在下一个请求中使用令牌。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` ## 错误 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListDatasets) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasets) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasets) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasets) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasets) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasets) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasets) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasets) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasets) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasets) # ListExplainabilities 返回使用 [CreateExplainability](API_CreateExplainability.md) 操作创建的可解释性资源的列表。该操作返回每个可解释性的摘要。您可以使用 [Filter](API_Filter.md) 对象数组筛选列表。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 要检索特定可解释性资源的完整属性集，将 ARN 与 [DescribeExplainability](API_DescribeExplainability.md) 操作结合使用。 ## 请求语法 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Filters](#API_ListExplainabilities_RequestSyntax) ** 筛选条件数组。对于每个筛选条件，提供一个条件和一个匹配语句。条件为 `IS` 或 `IS_NOT`，指定包括还是从列表中排除与语句匹配的资源。匹配语句包含一个键和一个值。 **筛选条件属性** + `Condition` - 适用的条件。有效值为 `IS` 和 `IS_NOT`。 + `Key` - 要筛选的参数的名称。有效值为 `ResourceArn` 和 `Status`。 + `Value` - 要匹配的值。类型：[Filter](API_Filter.md) 对象数组必需：否 ** [MaxResults](#API_ListExplainabilities_RequestSyntax) ** 响应中返回的项目数。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [NextToken](#API_ListExplainabilities_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 NextToken。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` 必需：否 ## 响应语法 ``` { "Explainabilities": [ { "CreationTime": number, "ExplainabilityArn": "string", "ExplainabilityConfig": { "TimePointGranularity": "string", "TimeSeriesGranularity": "string" }, "ExplainabilityName": "string", "LastModificationTime": number, "Message": "string", "ResourceArn": "string", "Status": "string" } ], "NextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Explainabilities](#API_ListExplainabilities_ResponseSyntax) ** 汇总每个可解释性资源属性的对象数组。类型：[ExplainabilitySummary](API_ExplainabilitySummary.md) 对象数组 ** [NextToken](#API_ListExplainabilities_ResponseSyntax) ** 在响应截断时将返回该令牌。要检索下一个结果集，请在下一个请求中使用令牌。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListExplainabilities) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListExplainabilities) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListExplainabilities) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListExplainabilities) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListExplainabilities) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListExplainabilities) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListExplainabilities) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListExplainabilities) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListExplainabilities) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListExplainabilities) # ListExplainabilityExports 返回使用 [CreateExplainabilityExport](API_CreateExplainabilityExport.md) 操作创建的可解释性导出的列表。该操作返回每个可解释性导出的摘要。您可以使用 [Filter](API_Filter.md) 对象数组筛选列表。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 要检索特定可解释性导出的完整属性集，将 ARN 与 [DescribeExplainability](API_DescribeExplainability.md) 操作结合使用。 ## 请求语法 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Filters](#API_ListExplainabilityExports_RequestSyntax) ** 筛选条件数组。对于每个筛选条件，提供一个条件和一个匹配语句。条件为 `IS` 或 `IS_NOT`，指定包括还是从列表中排除与语句匹配的资源。匹配语句包含一个键和一个值。 **筛选条件属性** + `Condition` - 适用的条件。有效值为 `IS` 和 `IS_NOT`。 + `Key` - 要筛选的参数的名称。有效值为 `ResourceArn` 和 `Status`。 + `Value` - 要匹配的值。类型：[Filter](API_Filter.md) 对象数组必需：否 ** [MaxResults](#API_ListExplainabilityExports_RequestSyntax) ** 响应中需返回的项目数。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [NextToken](#API_ListExplainabilityExports_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 NextToken。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` 必需：否 ## 响应语法 ``` { "ExplainabilityExports": [ { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ExplainabilityExportArn": "string", "ExplainabilityExportName": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ], "NextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [ExplainabilityExports](#API_ListExplainabilityExports_ResponseSyntax) ** 汇总每个可解释性导出属性的对象数组。类型：[ExplainabilityExportSummary](API_ExplainabilityExportSummary.md) 对象数组 ** [NextToken](#API_ListExplainabilityExports_ResponseSyntax) ** 在响应截断时将返回该令牌。要检索下一个结果集，请在下一个请求中使用令牌。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListExplainabilityExports) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListExplainabilityExports) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListExplainabilityExports) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListExplainabilityExports) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListExplainabilityExports) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListExplainabilityExports) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListExplainabilityExports) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListExplainabilityExports) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListExplainabilityExports) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListExplainabilityExports) # ListForecastExportJobs 返回使用 [CreateForecastExportJob](API_CreateForecastExportJob.md) 操作创建的预测导出作业列表。对于每个预测导出作业，该操作返回其属性摘要，包括 Amazon 资源名称（ARN）。要检索完整的属性集，将 ARN 与 [DescribeForecastExportJob](API_DescribeForecastExportJob.md) 操作结合使用。您可以使用 [Filter](API_Filter.md) 对象数组筛选列表。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Filters](#API_ListForecastExportJobs_RequestSyntax) ** 筛选条件数组。对于每个筛选条件，都要提供一个条件和一个匹配语句。条件为 `IS` 或 `IS_NOT`，指定包括还是从列表中排除与语句匹配的预测导出作业。匹配语句包含一个键和一个值。 **筛选条件属性** + `Condition` - 适用的条件。有效值为 `IS` 和 `IS_NOT`。要包括与语句匹配的预测导出作业，请指定 `IS`。要排除匹配的预测导出作业，请指定 `IS_NOT`。 + `Key` - 要筛选的参数的名称。有效值为 `ForecastArn` 和 `Status`。 + `Value` - 要匹配的值。例如，要列出所有导出名称为 *electricityforecast* 的预测的作业，请指定以下筛选条件： `"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2::forecast/electricityforecast" } ]` 类型：[Filter](API_Filter.md) 对象数组必需：否 ** [MaxResults](#API_ListForecastExportJobs_RequestSyntax) ** 响应中需返回的项目数。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [NextToken](#API_ListForecastExportJobs_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 `NextToken`。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` 必需：否 ## 响应语法 ``` { "ForecastExportJobs": [ { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ForecastExportJobArn": "string", "ForecastExportJobName": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ], "NextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [ForecastExportJobs](#API_ListForecastExportJobs_ResponseSyntax) ** 汇总每个导出作业属性的对象数组。类型：[ForecastExportJobSummary](API_ForecastExportJobSummary.md) 对象数组 ** [NextToken](#API_ListForecastExportJobs_ResponseSyntax) ** 如果响应被截断，Amazon Forecast 将返回该令牌。要检索下一个结果集，请在下一个请求中使用令牌。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListForecastExportJobs) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListForecastExportJobs) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListForecastExportJobs) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListForecastExportJobs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListForecastExportJobs) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListForecastExportJobs) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListForecastExportJobs) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListForecastExportJobs) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListForecastExportJobs) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListForecastExportJobs) # ListForecasts 返回使用 [CreateForecast](API_CreateForecast.md) 操作创建的预测列表。对于每个预测，该操作返回其属性摘要，包括 Amazon 资源名称（ARN）。要检索完整的属性集，请使用 [DescribeForecast](API_DescribeForecast.md) 操作指定 ARN。您可以使用 [Filter](API_Filter.md) 对象数组筛选列表。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Filters](#API_ListForecasts_RequestSyntax) ** 筛选条件数组。对于每个筛选条件，都要提供一个条件和一个匹配语句。条件为 `IS` 或 `IS_NOT`，指定包括还是从列表中排除与语句匹配的预测。匹配语句包含一个键和一个值。 **筛选条件属性** + `Condition` - 适用的条件。有效值为 `IS` 和 `IS_NOT`。要包括与该语句匹配的预测，请指定 `IS`。要排除匹配的预测，请指定 `IS_NOT`。 + `Key` - 要筛选的参数的名称。有效值包括 `DatasetGroupArn`、`PredictorArn` 和 `Status`。 + `Value` - 要匹配的值。例如，要列出所有状态为“非活动”的预测，需要指定： `"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]` 类型：[Filter](API_Filter.md) 对象数组必需：否 ** [MaxResults](#API_ListForecasts_RequestSyntax) ** 响应中需返回的项目数。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [NextToken](#API_ListForecasts_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 `NextToken`。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` 必需：否 ## 响应语法 ``` { "Forecasts": [ { "CreatedUsingAutoPredictor": boolean, "CreationTime": number, "DatasetGroupArn": "string", "ForecastArn": "string", "ForecastName": "string", "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "Status": "string" } ], "NextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Forecasts](#API_ListForecasts_ResponseSyntax) ** 汇总每个预测属性的对象数组。类型：[ForecastSummary](API_ForecastSummary.md) 对象数组 ** [NextToken](#API_ListForecasts_ResponseSyntax) ** 如果响应被截断，Amazon Forecast 将返回该令牌。要检索下一个结果集，请在下一个请求中使用令牌。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListForecasts) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListForecasts) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListForecasts) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListForecasts) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListForecasts) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListForecasts) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListForecasts) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListForecasts) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListForecasts) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListForecasts) # ListMonitorEvaluations 返回监控资源在不同时间段内收集的监控评估结果和预测器事件的列表。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 有关监控的更多信息，请参阅 [预测器监控](predictor-monitoring.md)。有关检索监控结果的更多信息，请参阅[查看监控结果](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html)。 ## 请求语法 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "MonitorArn": "string", "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Filters](#API_ListMonitorEvaluations_RequestSyntax) ** 筛选条件数组。对于每个筛选条件，提供一个条件和一个匹配语句。条件为 `IS` 或 `IS_NOT`，指定包括还是从列表中排除与语句匹配的资源。匹配语句包含一个键和一个值。 **筛选条件属性** + `Condition` - 适用的条件。有效值为 `IS` 和 `IS_NOT`。 + `Key` - 要筛选的参数的名称。唯一有效值为 `EvaluationState`。 + `Value` - 要匹配的值。有效值仅为 `SUCCESS` 或 `FAILURE`。例如，如果要仅列出成功的监控评估，需要指定： `"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]` 类型：[Filter](API_Filter.md) 对象数组必需：否 ** [MaxResults](#API_ListMonitorEvaluations_RequestSyntax) ** 要返回的最大监控结果数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [MonitorArn](#API_ListMonitorEvaluations_RequestSyntax) ** 要从中获取结果的监控资源的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [NextToken](#API_ListMonitorEvaluations_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 `NextToken`。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` 必需：否 ## 响应语法 ``` { "NextToken": "string", "PredictorMonitorEvaluations": [ { "EvaluationState": "string", "EvaluationTime": number, "Message": "string", "MetricResults": [ { "MetricName": "string", "MetricValue": number } ], "MonitorArn": "string", "MonitorDataSource": { "DatasetImportJobArn": "string", "ForecastArn": "string", "PredictorArn": "string" }, "NumItemsEvaluated": number, "PredictorEvent": { "Datetime": number, "Detail": "string" }, "ResourceArn": "string", "WindowEndDatetime": number, "WindowStartDatetime": number } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [NextToken](#API_ListMonitorEvaluations_ResponseSyntax) ** 如果响应被截断，Amazon Forecast 将返回该令牌。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` ** [PredictorMonitorEvaluations](#API_ListMonitorEvaluations_ResponseSyntax) ** 监控资源在不同时间段内收集的监控结果和预测器事件。有关监控的信息，请参阅[查看监控结果](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html)。有关检索监控结果的更多信息，请参阅[查看监控结果](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html)。类型：[PredictorMonitorEvaluation](API_PredictorMonitorEvaluation.md) 对象数组 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListMonitorEvaluations) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListMonitorEvaluations) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListMonitorEvaluations) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListMonitorEvaluations) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListMonitorEvaluations) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListMonitorEvaluations) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListMonitorEvaluations) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListMonitorEvaluations) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListMonitorEvaluations) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListMonitorEvaluations) # ListMonitors 返回使用 [CreateMonitor](API_CreateMonitor.md) 操作和 [CreateAutoPredictor](API_CreateAutoPredictor.md) 操作创建的监控器的列表。对于每个监控资源，该操作返回其属性摘要，包括 Amazon 资源名称（ARN）。通过在 [DescribeMonitor](API_DescribeMonitor.md) 操作中指定监控器的 ARN，可以检索监控资源的完整属性集。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Filters](#API_ListMonitors_RequestSyntax) ** 筛选条件数组。对于每个筛选条件，提供一个条件和一个匹配语句。条件为 `IS` 或 `IS_NOT`，指定包括还是从列表中排除与语句匹配的资源。匹配语句包含一个键和一个值。 **筛选条件属性** + `Condition` - 适用的条件。有效值为 `IS` 和 `IS_NOT`。 + `Key` - 要筛选的参数的名称。唯一有效值为 `Status`。 + `Value` - 要匹配的值。例如，要列出所有状态为“活动”的监控器，需要指定： `"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]` 类型：[Filter](API_Filter.md) 对象数组必需：否 ** [MaxResults](#API_ListMonitors_RequestSyntax) ** 需包括在响应中的最大监控器数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [NextToken](#API_ListMonitors_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 `NextToken`。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` 必需：否 ## 响应语法 ``` { "Monitors": [ { "CreationTime": number, "LastModificationTime": number, "MonitorArn": "string", "MonitorName": "string", "ResourceArn": "string", "Status": "string" } ], "NextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Monitors](#API_ListMonitors_ResponseSyntax) ** 用于汇总每个监控器属性的数组。类型：[MonitorSummary](API_MonitorSummary.md) 对象数组 ** [NextToken](#API_ListMonitors_ResponseSyntax) ** 如果响应被截断，Amazon Forecast 将返回该令牌。要检索下一个结果集，请在下一个请求中使用令牌。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListMonitors) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListMonitors) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListMonitors) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListMonitors) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListMonitors) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListMonitors) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListMonitors) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListMonitors) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListMonitors) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListMonitors) # ListPredictorBacktestExportJobs 返回使用 [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md) 操作创建的预测器回测导出作业的列表。该操作返回每个回测导出作业的摘要。您可以使用 [Filter](API_Filter.md) 对象数组筛选列表。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 要检索特定回测导出作业的完整属性集，将 ARN 与 [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md) 操作结合使用。 ## 请求语法 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Filters](#API_ListPredictorBacktestExportJobs_RequestSyntax) ** 筛选条件数组。对于每个筛选条件，提供一个条件和一个匹配语句。条件为 `IS` 或 `IS_NOT`，指定包括还是从列表中排除与语句匹配的预测器回测导出作业。匹配语句包含一个键和一个值。 **筛选条件属性** + `Condition` - 适用的条件。有效值为 `IS` 和 `IS_NOT`。要包括与语句匹配的预测器回测导出作业，请指定 `IS`。要排除匹配的预测器回测导出作业，请指定 `IS_NOT`。 + `Key` - 要筛选的参数的名称。有效值为 `PredictorArn` 和 `Status`。 + `Value` - 要匹配的值。类型：[Filter](API_Filter.md) 对象数组必需：否 ** [MaxResults](#API_ListPredictorBacktestExportJobs_RequestSyntax) ** 响应中需返回的项目数。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [NextToken](#API_ListPredictorBacktestExportJobs_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 NextToken。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` 必需：否 ## 响应语法 ``` { "NextToken": "string", "PredictorBacktestExportJobs": [ { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "LastModificationTime": number, "Message": "string", "PredictorBacktestExportJobArn": "string", "PredictorBacktestExportJobName": "string", "Status": "string" } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [NextToken](#API_ListPredictorBacktestExportJobs_ResponseSyntax) ** 在响应截断时将返回该令牌。要检索下一个结果集，请在下一个请求中使用令牌。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` ** [PredictorBacktestExportJobs](#API_ListPredictorBacktestExportJobs_ResponseSyntax) ** 汇总每个预测器回测导出作业属性的对象数组。类型：[PredictorBacktestExportJobSummary](API_PredictorBacktestExportJobSummary.md) 对象数组 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListPredictorBacktestExportJobs) # ListPredictors 返回使用 [CreateAutoPredictor](API_CreateAutoPredictor.md) 或 [CreatePredictor](API_CreatePredictor.md) 操作创建的预测器列表。对于每个预测器，该操作返回其属性摘要，包括 Amazon 资源名称（ARN）。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 您可以通过将 ARN 与 [DescribeAutoPredictor](API_DescribeAutoPredictor.md) 和 [DescribePredictor](API_DescribePredictor.md) 操作结合使用，检索完整的属性集。您可以使用 [Filter](API_Filter.md) 对象数组筛选列表。 ## 请求语法 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Filters](#API_ListPredictors_RequestSyntax) ** 筛选条件数组。对于每个筛选条件，都要提供一个条件和一个匹配语句。条件为 `IS` 或 `IS_NOT`，指定包括还是从列表中排除与语句匹配的预测器。匹配语句包含一个键和一个值。 **筛选条件属性** + `Condition` - 适用的条件。有效值为 `IS` 和 `IS_NOT`。要包括与语句匹配的预测器，请指定 `IS`。要排除匹配的预测器，请指定 `IS_NOT`。 + `Key` - 要筛选的参数的名称。有效值为 `DatasetGroupArn` 和 `Status`。 + `Value` - 要匹配的值。例如，要列出状态为“活动”的所有预测器，需要指定： `"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]` 类型：[Filter](API_Filter.md) 对象数组必需：否 ** [MaxResults](#API_ListPredictors_RequestSyntax) ** 响应中需返回的项目数。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [NextToken](#API_ListPredictors_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 `NextToken`。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` 必需：否 ## 响应语法 ``` { "NextToken": "string", "Predictors": [ { "CreationTime": number, "DatasetGroupArn": "string", "IsAutoPredictor": boolean, "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "PredictorName": "string", "ReferencePredictorSummary": { "Arn": "string", "State": "string" }, "Status": "string" } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [NextToken](#API_ListPredictors_ResponseSyntax) ** 如果响应被截断，Amazon Forecast 将返回该令牌。要检索下一个结果集，请在下一个请求中使用令牌。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` ** [Predictors](#API_ListPredictors_ResponseSyntax) ** 汇总每个预测器属性的对象数组。类型：[PredictorSummary](API_PredictorSummary.md) 对象数组 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListPredictors) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListPredictors) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListPredictors) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListPredictors) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListPredictors) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListPredictors) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListPredictors) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListPredictors) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListPredictors) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListPredictors) # ListTagsForResource 列出 Amazon Forecast 资源的标签。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "ResourceArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) ** 标识要列出其标签的资源的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Tags](#API_ListTagsForResource_ResponseSyntax) ** 资源的标签。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListTagsForResource) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListTagsForResource) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListTagsForResource) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListTagsForResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListTagsForResource) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListTagsForResource) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListTagsForResource) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListTagsForResource) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListTagsForResource) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListTagsForResource) # ListWhatIfAnalyses 返回使用 [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) 操作创建的假设分析的列表。对于每个假设分析，该操作返回其属性摘要，包括 Amazon 资源名称（ARN）。您可以通过将假设分析 ARN 与 [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) 操作结合使用，检索完整的属性集。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Filters](#API_ListWhatIfAnalyses_RequestSyntax) ** 筛选条件数组。对于每个筛选条件，都要提供一个条件和一个匹配语句。条件为 `IS` 或 `IS_NOT`，指定包括还是从列表中排除与语句匹配的假设分析作业。匹配语句包含一个键和一个值。 **筛选条件属性** + `Condition` - 适用的条件。有效值为 `IS` 和 `IS_NOT`。要包括与语句匹配的假设分析作业，请指定 `IS`。要排除匹配的假设分析作业，请指定 `IS_NOT`。 + `Key` - 要筛选的参数的名称。有效值为 `WhatIfAnalysisArn` 和 `Status`。 + `Value` - 要匹配的值。例如，要列出导出名为的预测的所有作业 *electricityWhatIf*，请指定以下筛选器： `"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2::forecast/electricityWhatIf" } ]` 类型：[Filter](API_Filter.md) 对象数组必需：否 ** [MaxResults](#API_ListWhatIfAnalyses_RequestSyntax) ** 响应中需返回的项目数。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [NextToken](#API_ListWhatIfAnalyses_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 `NextToken`。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` 必需：否 ## 响应语法 ``` { "NextToken": "string", "WhatIfAnalyses": [ { "CreationTime": number, "ForecastArn": "string", "LastModificationTime": number, "Message": "string", "Status": "string", "WhatIfAnalysisArn": "string", "WhatIfAnalysisName": "string" } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [NextToken](#API_ListWhatIfAnalyses_ResponseSyntax) ** 如果响应被截断，Forecast 将返回该令牌。要检索下一个结果集，请在下一个请求中使用令牌。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` ** [WhatIfAnalyses](#API_ListWhatIfAnalyses_ResponseSyntax) ** 描述匹配分析的 `WhatIfAnalysisSummary` 对象的数组。类型：[WhatIfAnalysisSummary](API_WhatIfAnalysisSummary.md) 对象数组 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfAnalyses) # ListWhatIfForecastExports 返回使用 [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) 操作创建的假设分析预测导出的列表。对于每个假设分析预测导出，该操作返回其属性摘要，包括 Amazon 资源名称（ARN）。您可以通过将假设分析预测导出 ARN 与 [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) 操作结合使用，检索完整的属性集。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Filters](#API_ListWhatIfForecastExports_RequestSyntax) ** 筛选条件数组。对于每个筛选条件，都要提供一个条件和一个匹配语句。条件为 `IS` 或 `IS_NOT`，指定包括还是从列表中排除与语句匹配的假设分析预测导出作业。匹配语句包含一个键和一个值。 **筛选条件属性** + `Condition` - 适用的条件。有效值为 `IS` 和 `IS_NOT`。要包括与语句匹配的预测导出作业，请指定 `IS`。要排除匹配的预测导出作业，请指定 `IS_NOT`。 + `Key` - 要筛选的参数的名称。有效值为 `WhatIfForecastExportArn` 和 `Status`。 + `Value` - 要匹配的值。例如，要列出导出名为 “*电力*” 的预测的所有作业WIFExport，请指定以下筛选器： `"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value": "arn:aws:forecast:us-west-2::forecast/electricityWIFExport" } ]` 类型：[Filter](API_Filter.md) 对象数组必需：否 ** [MaxResults](#API_ListWhatIfForecastExports_RequestSyntax) ** 响应中需返回的项目数。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [NextToken](#API_ListWhatIfForecastExports_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 `NextToken`。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` 必需：否 ## 响应语法 ``` { "NextToken": "string", "WhatIfForecastExports": [ { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "LastModificationTime": number, "Message": "string", "Status": "string", "WhatIfForecastArns": [ "string" ], "WhatIfForecastExportArn": "string", "WhatIfForecastExportName": "string" } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [NextToken](#API_ListWhatIfForecastExports_ResponseSyntax) ** 如果响应被截断，Forecast 将返回该令牌。要检索下一个结果集，请在下一个请求中使用令牌。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` ** [WhatIfForecastExports](#API_ListWhatIfForecastExports_ResponseSyntax) ** 描述匹配预测导出的 `WhatIfForecastExports` 对象的数组。类型：[WhatIfForecastExportSummary](API_WhatIfForecastExportSummary.md) 对象数组 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfForecastExports) # ListWhatIfForecasts 返回使用 [CreateWhatIfForecast](API_CreateWhatIfForecast.md) 操作创建的假设分析预测列表。对于每个假设分析预测，该操作返回其属性摘要，包括 Amazon 资源名称（ARN）。您可以通过将假设分析预测 ARN 与 [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) 操作结合使用，检索完整的属性集。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [Filters](#API_ListWhatIfForecasts_RequestSyntax) ** 筛选条件数组。对于每个筛选条件，都要提供一个条件和一个匹配语句。条件为 `IS` 或 `IS_NOT`，指定包括还是从列表中排除与语句匹配的假设分析预测导出作业。匹配语句包含一个键和一个值。 **筛选条件属性** + `Condition` - 适用的条件。有效值为 `IS` 和 `IS_NOT`。要包括与语句匹配的预测导出作业，请指定 `IS`。要排除匹配的预测导出作业，请指定 `IS_NOT`。 + `Key` - 要筛选的参数的名称。有效值为 `WhatIfForecastArn` 和 `Status`。 + `Value` - 要匹配的值。例如，要列出所有导出名为 Forecast 的预测*electricityWhatIf的*作业，请指定以下筛选条件： `"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2::forecast/electricityWhatIfForecast" } ]` 类型：[Filter](API_Filter.md) 对象数组必需：否 ** [MaxResults](#API_ListWhatIfForecasts_RequestSyntax) ** 响应中需返回的项目数。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [NextToken](#API_ListWhatIfForecasts_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 `NextToken`。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` 必需：否 ## 响应语法 ``` { "NextToken": "string", "WhatIfForecasts": [ { "CreationTime": number, "LastModificationTime": number, "Message": "string", "Status": "string", "WhatIfAnalysisArn": "string", "WhatIfForecastArn": "string", "WhatIfForecastName": "string" } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [NextToken](#API_ListWhatIfForecasts_ResponseSyntax) ** 如果上一个请求的结果被截断，则响应将包含 `NextToken`。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。模式：`.+` ** [WhatIfForecasts](#API_ListWhatIfForecasts_ResponseSyntax) ** 描述匹配预测的 `WhatIfForecasts` 对象的数组。类型：[WhatIfForecastSummary](API_WhatIfForecastSummary.md) 对象数组 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListWhatIfForecasts) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfForecasts) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfForecasts) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfForecasts) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfForecasts) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfForecasts) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfForecasts) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfForecasts) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfForecasts) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfForecasts) # ResumeResource 恢复已停止的监控资源。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "ResourceArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ResourceArn](#API_ResumeResource_RequestSyntax) ** 要恢复的监控资源的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** LimitExceededException ** 超过了每个账户的资源数量限制。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ResumeResource) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ResumeResource) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ResumeResource) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ResumeResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ResumeResource) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ResumeResource) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ResumeResource) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ResumeResource) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ResumeResource) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ResumeResource) # StopResource 停止资源。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 资源处于以下状态：`CREATE_STOPPING` 和 `CREATE_STOPPED`。资源一旦停止，就无法恢复。该操作可以应用于以下资源（及其相应的子资源）： + 数据集导入作业 + 预测器作业 + 预测作业 + 预测导出作业 + 预测器回测导出作业 + 可解释性作业 + 可解释性导出作业 ## 请求语法 ``` { "ResourceArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ResourceArn](#API_StopResource_RequestSyntax) ** 标识需停止资源的 Amazon 资源名称（ARN）。支持 ARNs的是`DatasetImportJobArn`、`PredictorArn`、`PredictorBacktestExportJobArn`、`ForecastArn`、`ForecastExportJobArn``ExplainabilityArn`、和`ExplainabilityExportArn`。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** LimitExceededException ** 超过了每个账户的资源数量限制。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/StopResource) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/StopResource) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/StopResource) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/StopResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/StopResource) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/StopResource) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/StopResource) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/StopResource) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/StopResource) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/StopResource) # TagResource 将指定的标签与具有指定 `resourceArn` 的资源相关联。如果未在请求参数中指定资源上的现有标签，则不会更改这些标签。在删除一项资源时，与该资源关联的标签也将删除。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "ResourceArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ResourceArn](#API_TagResource_RequestSyntax) ** 标识要列出其标签的资源的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [Tags](#API_TagResource_RequestSyntax) ** 要添加到该资源的标签。标签是键值对的数组。下面是适用于标签的基本限制： + 每个资源的最大标签数 - 50。 + 对于每个资源，每个标签键必须是唯一的，并且每个标签键只能有一个值。 + 最大键长度 - 128 个 Unicode 字符（采用 UTF-8 格式）。 + 最大值长度 - 256 个 Unicode 字符（采用 UTF-8 格式）。 + 如果您的标记模式针对多个服务和资源使用，请记得其它服务可能对允许使用的字符有限制。通常允许使用的字符包括：可用 UTF-8 格式表示的字母、数字和空格，以及以下字符：\$1：= . \$1 : / @。 + 标签键和值区分大小写。 + 请勿使用`aws:``AWS:`、或任何大写或小写组合，例如密钥的前缀，因为它是保留供 AWS 使用的。不能编辑或删除带此前缀的标签键。值可以带有该前缀。如果标签值将 `aws` 作为其前缀，但键没有前缀，则 Forecast 会将其视为用户标签，并将计入 50 个标签的限制。仅具有 `aws` 的键前缀的标签不计入每个资源的标签数限制。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** LimitExceededException ** 超过了每个账户的资源数量限制。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/TagResource) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/TagResource) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TagResource) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/TagResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TagResource) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/TagResource) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/TagResource) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/TagResource) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/TagResource) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TagResource) # UntagResource 从资源中删除指定的标签。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## 请求语法 ``` { "ResourceArn": "string", "TagKeys": [ "string" ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [ResourceArn](#API_UntagResource_RequestSyntax) ** 标识要列出其标签的资源的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [TagKeys](#API_UntagResource_RequestSyntax) ** 要删除的标签的键。类型：字符串数组数组成员：最少 0 个物品。最多 200 项。长度限制：最小长度为 1。最大长度为 128。模式：`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/UntagResource) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/UntagResource) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/UntagResource) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/UntagResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/UntagResource) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/UntagResource) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/UntagResource) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/UntagResource) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/UntagResource) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/UntagResource) # UpdateDatasetGroup 用指定的数据集替换数据集组中的数据集。 **重要** Amazon Forecast 已不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) **注意** 数据集组的 `Status` 必须为 `ACTIVE`，然后才能使用数据集组创建预测器。使用 [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) 操作获取此状态。 ## 请求语法 ``` { "DatasetArns": [ "string" ], "DatasetGroupArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [DatasetArns](#API_UpdateDatasetGroup_RequestSyntax) ** 要添加到数据集组的数据集的 Amazon 资源名称 (ARNs) 数组。类型：字符串数组长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [DatasetGroupArn](#API_UpdateDatasetGroup_RequestSyntax) ** 数据集组的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 我们无法处理该请求，因为其包含无效值或超出有效范围的值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们找不到具有该 Amazon 资源名称（ARN）的资源。检查 ARN，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/UpdateDatasetGroup) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/UpdateDatasetGroup) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/UpdateDatasetGroup) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/UpdateDatasetGroup) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/UpdateDatasetGroup) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/UpdateDatasetGroup) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/UpdateDatasetGroup) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/UpdateDatasetGroup) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/UpdateDatasetGroup) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/UpdateDatasetGroup) # Amazon Forecast 查询服务 Amazon Forecast 查询服务支持以下操作： + [QueryForecast](API_forecastquery_QueryForecast.md) + [QueryWhatIfForecast](API_forecastquery_QueryWhatIfForecast.md) # QueryForecast 根据提供的标准进行筛选，检索单个项目的预测。标准是一个键值对。键可以是来自 `TARGET_TIME_SERIES` 数据集的`item_id`（或同等的非时间戳、非目标字段），也可以是作为 `FeaturizationConfig` 对象一部分指定的预测维度之一。默认情况下，`QueryForecast` 返回筛选预测的完整日期范围。您可以请求特定的日期范围。要获得完整的预测，请使用[CreateForecastExportJob](https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html)操作。 **注意** Amazon Forecast 生成的预测与用于创建预测器的数据集处于同一时区。 ## 请求语法 ``` { "EndDate": "string", "Filters": { "string" : "string" }, "ForecastArn": "string", "NextToken": "string", "StartDate": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [EndDate](#API_forecastquery_QueryForecast_RequestSyntax) ** 预测的结束日期。使用以下格式指定日期： yyyy-MM-dd't'hh: mm: ss（ISO 8601 格式）。例如 2015-01-01T20:00:00。类型：字符串必需：否 ** [Filters](#API_forecastquery_QueryForecast_RequestSyntax) ** 检索预测时需要应用的筛选标准。例如，要获取用电量数据集中 `client_21` 的预测，请指定以下内容： `{"item_id" : "client_21"}` 要获得完整的预测，请使用[CreateForecastExportJob](https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html)操作。类型：字符串到字符串映射映射条目：最多 50 项。密钥长度限制：最大长度为 256。键模式：`^[a-zA-Z0-9\_\-]+$` 值长度限制：最大长度为 256。是否必需：是 ** [ForecastArn](#API_forecastquery_QueryForecast_RequestSyntax) ** 要查询的预测的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 是否必需：是 ** [NextToken](#API_forecastquery_QueryForecast_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 `NextToken`。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。必需：否 ** [StartDate](#API_forecastquery_QueryForecast_RequestSyntax) ** 预测的开始日期。使用以下格式指定日期： yyyy-MM-dd't'hh: mm: ss（ISO 8601 格式）。例如 2015-01-01T08:00:00。类型：字符串必需：否 ## 响应语法 ``` { "Forecast": { "Predictions": { "string" : [ { "Timestamp": "string", "Value": number } ] } } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Forecast](#API_forecastquery_QueryForecast_ResponseSyntax) ** 预测。类型：[Forecast](API_forecastquery_Forecast.md) 对象 ## 错误 ** InvalidInputException ** 该值无效或过长。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们无法找到该资源。检查您提供的信息，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecastquery-2018-06-26/QueryForecast) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecastquery-2018-06-26/QueryForecast) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/QueryForecast) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecastquery-2018-06-26/QueryForecast) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/QueryForecast) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecastquery-2018-06-26/QueryForecast) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecastquery-2018-06-26/QueryForecast) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecastquery-2018-06-26/QueryForecast) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecastquery-2018-06-26/QueryForecast) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/QueryForecast) # QueryWhatIfForecast 检索假设分析预测。 ## 请求语法 ``` { "EndDate": "string", "Filters": { "string" : "string" }, "NextToken": "string", "StartDate": "string", "WhatIfForecastArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [EndDate](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) ** 假设分析预测的结束日期。使用以下格式指定日期： yyyy-MM-dd't'hh: mm: ss（ISO 8601 格式）。例如 2015-01-01T20:00:00。类型：字符串必需：否 ** [Filters](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) ** 检索预测时需要应用的筛选标准。例如，要获取用电量数据集中 `client_21` 的预测，请指定以下内容： `{"item_id" : "client_21"}` 要获得完整的假设预测，请使用操作。[CreateForecastExportJob](https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html) 类型：字符串到字符串映射映射条目：最多 50 项。密钥长度限制：最大长度为 256。键模式：`^[a-zA-Z0-9\_\-]+$` 值长度限制：最大长度为 256。是否必需：是 ** [NextToken](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) ** 如果上一个请求的结果被截断，则响应将包含 `NextToken`。要检索下一个结果集，请在下一个请求中使用令牌。令牌在 24 小时后过期。类型：字符串长度限制：最小长度为 1。最大长度为 3000。必需：否 ** [StartDate](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) ** 假设分析预测的开始日期。使用以下格式指定日期： yyyy-MM-dd't'hh: mm: ss（ISO 8601 格式）。例如 2015-01-01T08:00:00。类型：字符串必需：否 ** [WhatIfForecastArn](#API_forecastquery_QueryWhatIfForecast_RequestSyntax) ** 要查询的假设分析预测的 Amazon 资源名称（ARN）。类型：字符串长度限制：最大长度为 300。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` 必需：是 ## 响应语法 ``` { "Forecast": { "Predictions": { "string" : [ { "Timestamp": "string", "Value": number } ] } } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Forecast](#API_forecastquery_QueryWhatIfForecast_ResponseSyntax) ** 提供有关预测的信息。作为 [QueryForecast](API_forecastquery_QueryForecast.md) 响应的一部分返回。类型：[Forecast](API_forecastquery_Forecast.md) 对象 ## 错误 ** InvalidInputException ** 该值无效或过长。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。令牌在 24 小时后过期。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 我们无法找到该资源。检查您提供的信息，然后重试。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecastquery-2018-06-26/QueryWhatIfForecast) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/QueryWhatIfForecast)