DescribeDataset - Amazon Forecast

Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。了解更多

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

DescribeDataset

描述使用该CreateDataset操作创建的 Amazon Forecast 数据集。

重要

Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。了解更多

除了列出 CreateDataset 请求中指定的参数外,该操作还包括以下数据集属性:

  • CreationTime

  • LastModificationTime

  • Status

请求语法

{ "DatasetArn": "string" }

请求参数

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

DatasetArn

数据集的 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

创建数据集的时间。

类型:时间戳

DataFrequency

数据收集的频率。

有效间隔为 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

数据集的 Amazon 资源名称 (ARN)。

类型:字符串

长度约束:最大长度为 256。

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

DatasetName

数据集的名称。

类型:字符串

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

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

DatasetType

数据集类型。

类型:字符串

有效值:TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA

Domain

与数据集关联的域。

类型:字符串

有效值:RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS

EncryptionConfig

Amazon Forecast 可以代入的 AWS Identity and Access Management (IAM) 密钥和 () 角色来访问密钥。 AWS Key Management Service KMS

类型:EncryptionConfig 对象

LastModificationTime

创建数据集时,LastModificationTimeCreationTime 相同。当数据被导入数据集时,LastModificationTimeDescribeDataset 调用的当前时间。CreateDatasetImportJob操作完成后,LastModificationTime是指导入任务完成或失败的时候。

类型:时间戳

Schema

用于指定数据集字段的 SchemaAttribute 对象数组。每个 SchemaAttribute 都指定字段的名称和数据类型。

类型:Schema 对象

Status

数据集的状态。状态包括:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

这些UPDATE状态适用于通过调用CreateDatasetImportJob操作将数据导入数据集并反映数据集导入任务的状态。例如,当导入作业状态为 CREATE_IN_PROGRESS 时,数据集的状态为 UPDATE_IN_PROGRESS

注意

在可以导入训练数据之前,数据集的 Status 必须为 ACTIVE

类型:字符串

长度约束:最大长度为 256。

错误

InvalidInputException

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

HTTP状态码:400

ResourceNotFoundException

我们找不到带有该 Amazon 资源名称的资源 (ARN)。请检查ARN并重试。

HTTP状态码:400

另请参阅

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