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
Descreve um recurso de explicabilidade criado por meio da operação CreateExplainability.
Sintaxe da Solicitação
{
"ExplainabilityArn": "string"
}Parâmetros da solicitação
A solicitação aceita os dados a seguir no formato JSON.
- ExplainabilityArn
-
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:.*:.*:.+Exigido: Sim
Sintaxe da Resposta
{
"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
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
-
Quando o recurso de explicabilidade foi criado.
Tipo: carimbo de data/hora
- DataSource
-
A fonte dos seus dados, uma função AWS Identity and Access Management (IAM) que permite ao Amazon Forecast acessar os dados e, opcionalmente, uma chave AWS Key Management Service (KMS).
Tipo: objeto DataSource
- EnableVisualization
-
Se a visualização foi ou não habilitada para o recurso de explicabilidade.
Tipo: booliano
- EndDateTime
-
Se
TimePointGranularityfor definido comoSPECIFIC, 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
-
O tempo estimado restante em minutos para a conclusão do trabalho CreateExplainability.
Tipo: longo
- ExplainabilityArn
-
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
-
As configurações que definem a granularidade das séries temporais e dos pontos no tempo para a explicabilidade.
Tipo: objeto ExplainabilityConfig
- ExplainabilityName
-
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
-
A última vez que o recurso foi modificado. O carimbo de data e hora depende do status do trabalho:
-
CREATE_PENDING: oCreationTime. -
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. -
ACTIVEouCREATE_FAILED: quando o trabalho foi concluído ou falhou.
Tipo: Timestamp
-
- Message
-
Se ocorreu um erro, uma mensagem sobre o erro.
Tipo: string
- ResourceArn
-
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
-
Define os campos de um conjunto de dados.
Tipo: objeto Schema
- StartDateTime
-
Se
TimePointGranularityfor definido comoSPECIFIC, 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
-
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
- 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
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte:
