Post x amz targetamazonforecast.describeexplainability

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1463278347.3 KB

Describes an Explainability resource created using the <a>CreateExplainability</a> operation.

post/#X-Amz-Target=AmazonForecast.DescribeExplainability

Headers

X-Amz-Target'AmazonForecast.DescribeExplainability' required

Request body

ExplainabilityArnstring required

The Amazon Resource Name (ARN) of the Explaianability to describe.

Response

Success

ExplainabilityArnstring

The Amazon Resource Name (ARN) of the Explainability.

ExplainabilityNamestring

The name of the Explainability.

ResourceArnstring

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.

EnableVisualizationboolean

Whether the visualization was enabled for the Explainability resource.

StartDateTimestring

If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, the first time point in the Explainability.

EndDateTimestring

If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, the last time point in the Explainability.

EstimatedTimeRemainingInMinutesinteger

The estimated time remaining in minutes for the <a>CreateExplainability</a> job to complete.

Messagestring

If an error occurred, a message about the error.

Statusstring

The status of the Explainability resource. States include: <ul> <li> <code>ACTIVE</code> </li> <li> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </li> <li> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </li> <li> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </li> </ul>

CreationTimestring date-time

When the Explainability resource was created.

LastModificationTimestring date-time

The last time the resource was modified. The timestamp depends on the status of the job: <ul> <li> <code>CREATE_PENDING</code> - The <code>CreationTime</code>. </li> <li> <code>CREATE_IN_PROGRESS</code> - The current timestamp. </li> <li> <code>CREATE_STOPPING</code> - The current timestamp. </li> <li> <code>CREATE_STOPPED</code> - When the job stopped. </li> <li> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed. </li> </ul>