---
title: "POST /#X-Amz-Target=AmazonForecast.DescribeExplainability"
method: POST
path: "/#X-Amz-Target=AmazonForecast.DescribeExplainability"
---

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

`POST /#X-Amz-Target=AmazonForecast.DescribeExplainability`

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

## Headers

- `X-Amz-Target` 'AmazonForecast.DescribeExplainability', required

## Request body

- DescribeExplainabilityRequest
  - `ExplainabilityArn` string, required — The Amazon Resource Name (ARN) of the Explaianability to describe.

## Response `200`

Success

- DescribeExplainabilityResponse
  - `ExplainabilityArn` string — The Amazon Resource Name (ARN) of the Explainability.
  - `ExplainabilityName` string — The name of the Explainability.
  - `ResourceArn` string — The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
  - `ExplainabilityConfig` object — The configuration settings that define the granularity of time series and time points for the Explainability.
    - `TimeSeriesGranularity` 'ALL' | 'SPECIFIC', required — <p>To create an Explainability for all time series in your datasets, use <code>ALL</code>. To create an Explainability for specific time series in your datasets, use <code>SPECIFIC</code>.</p> <p>Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the <a>DataDestination</a> data type.</p>
    - `TimePointGranularity` 'ALL' | 'SPECIFIC', required — <p>To create an Explainability for all time points in your forecast horizon, use <code>ALL</code>. To create an Explainability for specific time points in your forecast horizon, use <code>SPECIFIC</code>.</p> <p>Specify time points with the <code>StartDateTime</code> and <code>EndDateTime</code> parameters within the <a>CreateExplainability</a> operation.</p>
  - `EnableVisualization` boolean — Whether the visualization was enabled for the Explainability resource.
  - `DataSource` DataSource — The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.
    - `S3Config` object, required — The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.
      - `Path` string, required — The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
      - `RoleArn` string, required — <p>The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the <code>KMSKeyArn</code> key, the role must allow access to the key.</p> <p>Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an <code>InvalidInputException</code> error.</p>
      - `KMSKeyArn` string — The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.
  - `Schema` Schema — Defines the fields of a dataset.
    - `Attributes` SchemaAttribute[] — An array of attributes specifying the name and type of each field in a dataset.
      - `AttributeName` string — The name of the dataset field.
      - `AttributeType` 'string' | 'integer' | 'float' | 'timestamp' | 'geolocation' — <p>The data type of the field.</p> <p>For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).</p>
  - `StartDateTime` string — If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, the first time point in the Explainability.
  - `EndDateTime` string — If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, the last time point in the Explainability.
  - `EstimatedTimeRemainingInMinutes` integer — The estimated time remaining in minutes for the <a>CreateExplainability</a> job to complete.
  - `Message` string — If an error occurred, a message about the error.
  - `Status` string — <p>The status of the Explainability resource. States include: </p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul>
  - `CreationTime` string, date-time — When the Explainability resource was created.
  - `LastModificationTime` string, date-time — <p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>

## Other responses

- `480` — InvalidInputException
- `481` — ResourceNotFoundException

---

[API](https://skmtc.net/aws/apis/forecast.md) · [All operations](https://skmtc.net/aws/apis/forecast/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/forecast/versions/3d1c872d2ac9/schema)