DescribeDatasetImportJob - Amazon Forecast

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

DescribeDatasetImportJob

描述使用该CreateDatasetImportJob操作创建的数据集导入任务。

除了列出 CreateDatasetImportJob 请求中提供的参数外,该操作还包括以下属性:

  • CreationTime

  • LastModificationTime

  • DataSize

  • FieldStatistics

  • Status

  • Message - 如果出现错误,则为错误的相关信息。

请求语法

{ "DatasetImportJobArn": "string" }

请求参数

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

DatasetImportJobArn

数据集导入作业的 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

数据集导入作业的创建时间。

类型:时间戳

DatasetArn

导入训练数据的数据集的 Amazon 资源名称(ARN)。

类型:字符串

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

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

DatasetImportJobArn

数据集导入作业的 ARN。

类型:字符串

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

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

DatasetImportJobName

数据集导入作业的名称。

类型:字符串

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

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

DataSize

导入作业完成后数据集的大小,以千兆字节(GB)为单位。

类型:双精度

DataSource

要导入的训练数据的位置,以及 Amazon Forecast 可以代入以访问数据的AWS Identity and Access Management(IAM)角色。

如果使用加密,则 DataSource 包含 AWS Key Management Service(KMS)密钥。

类型:DataSource 对象

EstimatedTimeRemainingInMinutes

完成数据集导入作业的估计剩余时间(分钟)。

类型:长整型

FieldStatistics

输入数据中每个字段的统计信息。

类型:字符串到 Statistics 对象的映射

密钥长度限制:最大长度为 256。

键模式:^[a-zA-Z0-9\_]+$

Format

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

类型:字符串

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

模式:^CSV|PARQUET$

GeolocationFormat

地理位置属性的格式。有效值:"LAT_LONG""CC_POSTALCODE"

类型:字符串

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

模式:^[a-zA-Z0-9_]+$

ImportMode

数据集导入作业的导入模式,FULL 或 INCREMENTAL。

类型:字符串

有效值:FULL | INCREMENTAL

LastModificationTime

上次修改资源的时间。时间戳取决于作业的状态:

  • CREATE_PENDING - CreationTime

  • CREATE_IN_PROGRESS - 当前时间戳。

  • CREATE_STOPPING - 当前时间戳。

  • CREATE_STOPPED - 当作业停止时。

  • ACTIVE 或者 CREATE_FAILED - 当作业完成或失败时。

类型:时间戳

Message

如果出现错误,则为错误的信息消息。

类型:字符串

Status

数据集导入作业的状态。状态包括:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

类型:字符串

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

TimestampFormat

数据集中时间戳的格式。您指定的格式取决于创建数据集时 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

应用于数据集中每个项目的单一时区

类型:字符串

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

模式:^[a-zA-Z0-9\/\+\-\_]+$

UseGeolocationForTimeZone

TimeZone 是否自动从地理位置属性派生。

类型:布尔值

错误

InvalidInputException

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

HTTP 状态代码:400

ResourceNotFoundException

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

HTTP 状态代码:400

另请参阅

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