CreateWhatIfForecastExport - Amazon Forecast

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

CreateWhatIfForecastExport

CreateWhatIfForecast 操作创建的预测导出到 Amazon Simple Storage Service(Amazon S3)存储桶中。预测文件名将符合以下惯例:

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

< ExportTimestamp > 组件使用的是 Java SimpleDateFormat (yyy-mm-ddthhh-mm-ssz)。

您必须指定包含 AWS Identity and Access Management (IAM)角色的 DataDestination 对象,Amazon Forecast 可以代入该角色来访问 Amazon S3 存储桶。有关更多信息,请参阅 为 Amazon Forecast 设置权限

有关更多信息,请参阅 生成预测

要获取所有假设分析预测导出作业的列表,请使用 ListWhatIfForecastExports 操作。

注意

预测导出作业的 Status 必须为 ACTIVE,然后才能访问 Amazon S3 存储桶中的预测。要获取此状态,请使用 DescribeWhatIfForecastExport 操作。

请求语法

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

请求参数

请求接受采用 JSON 格式的以下数据。

Destination

您要保存预测的位置,以及 Amazon Forecast 可以代入的访问该位置的 AWS Identity and Access Management (IAM) 角色。必须将预测导出到 Amazon S3 存储桶中。

如果使用加密,则Destination必须包含 AWS Key Management Service (KMS) 密钥。IAM 角色必须允许 Amazon Forecast 访问密钥的权限。

类型:DataDestination 对象

必需:是

Format

导出数据的格式,CSV 或 PARQUET。

类型:字符串

长度限制:最大长度为 7。

模式:^CSV|PARQUET$

必需:否

Tags

适用于假设分析预测的标签列表。

类型:Tag 对象数组

数组成员:最少 0 个物品。最多 200 项。

必需:否

WhatIfForecastArns

要导出的假设分析预测 Amazon 资源名称(ARN)的列表。

类型:字符串数组

数组成员:最少 1 个物品。最多 50 项。

长度限制:最大长度为 300。

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

必需:是

WhatIfForecastExportName

要导出的假设分析预测的名称。

类型:字符串

长度限制:最小长度为 1。最大长度为 63。

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

必需:是

响应语法

{ "WhatIfForecastExportArn": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

WhatIfForecastExportArn

假设分析预测的 Amazon 资源名称(ARN)。

类型:字符串

长度限制:最大长度为 300。

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

错误

InvalidInputException

我们无法处理该请求,因为其包含无效值或超出有效范围的值。

HTTP 状态代码:400

LimitExceededException

超过了每个账户的资源数量限制。

HTTP 状态代码:400

ResourceAlreadyExistsException

已存在同名资源。请使用不同的名称重试。

HTTP 状态代码:400

ResourceInUseException

指定的资源正在使用中。

HTTP 状态代码:400

ResourceNotFoundException

我们找不到具有该 Amazon 资源名称(ARN)的资源。检查 ARN,然后重试。

HTTP 状态代码:400

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: