DescribeDataset - Amazon Forecast

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

DescribeDataset

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

除了列出在中指定的参数外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": [ { "AttributeCategory": "string", "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” 表示每个月,“30 分钟” 表示每 30 分钟一次。

类型: 字符串

长度约束:最小长度为 1。最大长度为 5。

模式:^1Y|Y|([1-9]|1[0-1])M|M|[1-4]W|W|[1-6]D|D|([1-9]|1[0-9]|2[0-3])H|H|([1-9]|[1-5][0-9])min$

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 | ALL_DATASET_TYPES

Domain

与数据集关联的域。

类型: 字符串

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

EncryptionConfig

AWS Key Management Service (KMS) 角色。Amazon Foresourct Management (IAM) 角色。

类型:EncryptionConfig 对象

LastModificationTime

在创建数据集时,LastModificationTime等同于CreationTime. 在将数据导入数据集时,LastModificationTime是当前的时间DescribeDataset调用。在经过一下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 Resource Name (ARN)。检查 ARN 并重试。

HTTP 状态代码:400

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: