DescribeExplainability - Amazon Forecast

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

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

DescribeExplainability

描述使用 CreateExplainability 操作创建的可解释性资源。

重要

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

请求语法

{ "ExplainabilityArn": "string" }

请求参数

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

ExplainabilityArn

要描述的可解释性的 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

创建可解释性资源的时间。

类型:时间戳

DataSource

您的数据来源、允许 Amazon Forecast 访问数据的 AWS Identity and Access Management (IAM) 角色以及 AWS Key Management Service (可选KMS)密钥。

类型:DataSource 对象

EnableVisualization

是否启用了可解释性资源的可视化。

类型:布尔值

EndDateTime

如果设置 TimePointGranularitySPECIFIC,则为可解释性中的最后一个时间点。

类型:字符串

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

模式:^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

EstimatedTimeRemainingInMinutes

完成 CreateExplainability 作业的估计剩余时间(分钟)。

类型:长整型

ExplainabilityArn

可解释性的 Amazon 资源名称 (ARN)。

类型:字符串

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

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

ExplainabilityConfig

定义可解释性的时间序列粒度和时间点的配置设置。

类型:ExplainabilityConfig 对象

ExplainabilityName

可解释性的名称。

类型:字符串

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

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

LastModificationTime

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

  • CREATE_PENDING - CreationTime

  • CREATE_IN_PROGRESS - 当前时间戳。

  • CREATE_STOPPING - 当前时间戳。

  • CREATE_STOPPED - 当作业停止时。

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

类型:时间戳

Message

如果出现错误,则为一条说明错误的消息。

类型:字符串

ResourceArn

用于创建可解释性资源的预测变量或 Forecast 的 Amazon 资源名称 (ARN)。

类型:字符串

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

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

Schema

定义数据集的字段。

类型:Schema 对象

StartDateTime

如果设置 TimePointGranularitySPECIFIC,则为可解释性中的第一个时间点。

类型:字符串

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

模式:^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

Status

可解释性资源的状态。状态包括:

  • 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,请参阅以下内容: