DescribeExplainability - Amazon Forecast

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

DescribeExplainability

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

请求语法

{ "ExplainabilityArn": "string" }

请求参数

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

ExplainabilityArn

要描述的可解释性的 Amazon Resource Name (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": [ { "AttributeCategory": "string", "AttributeName": "string", "AttributeType": "string" } ] }, "StartDateTime": "string", "Status": "string" }

响应元素

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

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

CreationTime

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

类型: 时间戳

DataSource

您的数据来源,允许 AAmazon Forecast Foresource Management (IAM) 角色和 AWS Key Management Service (KMS) 密钥(可选)。

类型:DataSource 对象

EnableVisualization

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

类型: 布尔值

EndDateTime

如果TimePointGranularity将设置为SPECIFIC,这是《可解释性》中的最后一个时间点。

类型: 字符串

长度约束:长度上限为 19。

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

EstimatedTimeRemainingInMinutes

的预计剩余时间(以分钟为单位)CreateExplainability任务待完成。

类型: 长整型

ExplainabilityArn

可解释性的 Amazon Resource Name (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

用于创建可解释性资源的 Amazon ResouForecast ce Name (ARN)。

类型: 字符串

长度约束:长度上限为 256。

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

Schema

定义数据集的字段。

类型:Schema 对象

StartDateTime

如果TimePointGranularity将设置为SPECIFIC,这是《可解释性》中的第一个时间点。

类型: 字符串

长度约束:长度上限为 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 Resource Name (ARN) 的资源。检查 ARN,然后重试。

HTTP 状态代码:400

另请参阅

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