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
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á.
DescribeForecast
Descreve uma previsão criada por meio da operação CreateForecast.
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
Além de listar as propriedades fornecidas na solicitação CreateForecast, essa operação inclui as seguintes propriedades:
-
DatasetGroupArn: o grupo de conjuntos de dados que forneceu os dados de treinamento. -
CreationTime -
LastModificationTime -
Status -
Message: se ocorreu um erro, as informações sobre o erro.
Sintaxe da Solicitação
{
"ForecastArn": "string"
}Parâmetros da solicitação
A solicitação aceita os seguintes dados no JSON formato.
- ForecastArn
-
O nome do recurso Amazon (ARN) da previsão.
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,
"DatasetGroupArn": "string",
"EstimatedTimeRemainingInMinutes": number,
"ForecastArn": "string",
"ForecastName": "string",
"ForecastTypes": [ "string" ],
"LastModificationTime": number,
"Message": "string",
"PredictorArn": "string",
"Status": "string",
"TimeSeriesSelector": {
"TimeSeriesIdentifiers": {
"DataSource": {
"S3Config": {
"KMSKeyArn": "string",
"Path": "string",
"RoleArn": "string"
}
},
"Format": "string",
"Schema": {
"Attributes": [
{
"AttributeName": "string",
"AttributeType": "string"
}
]
}
}
}
}Elementos de Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP de 200.
Os dados a seguir são retornados em JSON formato pelo serviço.
- CreationTime
-
Quando a tarefa de criação da previsão foi criada.
Tipo: carimbo de data/hora
- DatasetGroupArn
-
O ARN do grupo de conjuntos de dados que forneceu os dados usados para treinar o preditor.
Tipo: string
Restrições de tamanho: o tamanho máximo é 256.
Padrão:
arn:([a-z\d-]+):forecast:.*:.*:.+ - EstimatedTimeRemainingInMinutes
-
O tempo estimado restante em minutos para a conclusão do trabalho de previsão.
Tipo: longo
- ForecastArn
-
A previsão ARN conforme especificado na solicitação.
Tipo: string
Restrições de tamanho: o tamanho máximo é 256.
Padrão:
arn:([a-z\d-]+):forecast:.*:.*:.+ - ForecastName
-
O nome da previsão.
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_]* - ForecastTypes
-
Os quantis nos quais as previsões probabilísticas foram geradas.
Tipo: matriz de strings
Membros da matriz: número mínimo de 1 item. Número máximo de 20 itens.
Restrições de tamanho: o tamanho mínimo é 2. O tamanho máximo é 4.
Padrão:
(^0?\.\d\d?$|^mean$) - 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 informativa sobre o erro.
Tipo: string
- PredictorArn
-
O ARN do preditor usado para gerar a previsão.
Tipo: string
Restrições de tamanho: o tamanho máximo é 256.
Padrão:
arn:([a-z\d-]+):forecast:.*:.*:.+ - Status
-
O status da previsão. Os estados são:
-
ACTIVE -
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILED -
CREATE_STOPPING,CREATE_STOPPED -
DELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
nota
O
Statusda previsão deve serACTIVEpara que você possa consultar ou exportar a previsão.Tipo: string
Restrições de tamanho: o tamanho máximo é 256.
Padrão:
^[a-zA-Z0-9\_]+$ -
- TimeSeriesSelector
-
A série temporal a ser incluída na previsão.
Tipo: objeto TimeSeriesSelector
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.
HTTPCódigo de status: 400
- ResourceNotFoundException
-
Não conseguimos encontrar um recurso com esse nome de recurso da Amazon (ARN). Verifique ARN e tente novamente.
HTTPCódigo de status: 400
Consulte também
Para obter mais informações sobre como usar isso API em um idioma específico AWS SDKs, consulte o seguinte:
