O Amazon Forecast não está mais disponível para novos clientes. Os clientes existentes do Amazon Forecast podem continuar usando o serviço normalmente. [Saiba mais](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# DescribeExplainability
<a name="API_DescribeExplainability"></a>

Descreve um recurso de explicabilidade criado por meio da operação [CreateExplainability](API_CreateExplainability.md).

**Importante**  
O Amazon Forecast não está mais disponível para novos clientes. Os clientes existentes do Amazon Forecast podem continuar usando o serviço normalmente. [Saiba mais](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## Sintaxe da solicitação
<a name="API_DescribeExplainability_RequestSyntax"></a>

```
{
   "ExplainabilityArn": "string"
}
```

## Parâmetros da solicitação
<a name="API_DescribeExplainability_RequestParameters"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [ExplainabilityArn](#API_DescribeExplainability_RequestSyntax) **   <a name="forecast-DescribeExplainability-request-ExplainabilityArn"></a>
O nome do recurso da Amazon (ARN) da explicabilidade a ser descrita.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Obrigatório: sim

## Sintaxe da resposta
<a name="API_DescribeExplainability_ResponseSyntax"></a>

```
{
   "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"
}
```

## Elementos de resposta
<a name="API_DescribeExplainability_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [CreationTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-CreationTime"></a>
Quando o recurso de explicabilidade foi criado.  
Tipo: Timestamp

 ** [DataSource](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-DataSource"></a>
A fonte dos seus dados, uma função AWS Identity and Access Management (IAM) que permite que o Amazon Forecast acesse os dados e, opcionalmente, uma chave AWS Key Management Service (KMS).  
Tipo: objeto [DataSource](API_DataSource.md)

 ** [EnableVisualization](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-EnableVisualization"></a>
Se a visualização foi ou não habilitada para o recurso de explicabilidade.  
Tipo: booliano

 ** [EndDateTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-EndDateTime"></a>
Se `TimePointGranularity` for definido como `SPECIFIC`, o último ponto no tempo na explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 19.  
Padrão: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` 

 ** [EstimatedTimeRemainingInMinutes](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-EstimatedTimeRemainingInMinutes"></a>
O tempo estimado restante em minutos para a conclusão do trabalho [CreateExplainability](API_CreateExplainability.md).  
Tipo: longo

 ** [ExplainabilityArn](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ExplainabilityArn"></a>
O nome do recurso da Amazon (ARN) da explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [ExplainabilityConfig](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ExplainabilityConfig"></a>
As configurações que definem a granularidade das séries temporais e dos pontos no tempo para a explicabilidade.  
Tipo: objeto [ExplainabilityConfig](API_ExplainabilityConfig.md)

 ** [ExplainabilityName](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ExplainabilityName"></a>
O nome da explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Padrão: `^[a-zA-Z][a-zA-Z0-9_]*` 

 ** [LastModificationTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-LastModificationTime"></a>
A última vez que o recurso foi modificado. O carimbo de data e hora depende do status do trabalho:  
+  `CREATE_PENDING`: o `CreationTime`.
+  `CREATE_IN_PROGRESS`: o carimbo de data e hora atual.
+  `CREATE_STOPPING`: o carimbo de data e hora atual.
+  `CREATE_STOPPED`: quando o trabalho parou.
+  `ACTIVE` ou `CREATE_FAILED`: quando o trabalho foi concluído ou falhou.
Tipo: Timestamp

 ** [Message](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-Message"></a>
Se ocorreu um erro, uma mensagem sobre o erro.  
Tipo: string

 ** [ResourceArn](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-ResourceArn"></a>
O nome do recurso da Amazon (ARN) do preditor ou do Forecast usado para criar o recurso de explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):forecast:.*:.*:.+` 

 ** [Schema](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-Schema"></a>
Define os campos de um conjunto de dados.  
Tipo: objeto [Schema](API_Schema.md)

 ** [StartDateTime](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-StartDateTime"></a>
Se `TimePointGranularity` for definido como `SPECIFIC`, o primeiro ponto no tempo na explicabilidade.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 19.  
Padrão: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` 

 ** [Status](#API_DescribeExplainability_ResponseSyntax) **   <a name="forecast-DescribeExplainability-response-Status"></a>
O status do recurso de explicabilidade. Os estados são:   
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.

## Erros
<a name="API_DescribeExplainability_Errors"></a>

 ** InvalidInputException **   
Não podemos processar a solicitação porque ela inclui um valor inválido ou um valor que excede o intervalo válido.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
Não conseguimos encontrar um recurso com esse nome do recurso da Amazon (ARN). Verifique o ARN e tente novamente.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeExplainability_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeExplainability) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeExplainability)