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á.
DescribeAutoPredictor
Descreve um preditor criado usando a CreateAutoPredictor operação.
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
Sintaxe da Solicitação
{
"PredictorArn": "string"
}Parâmetros da solicitação
A solicitação aceita os seguintes dados no JSON formato.
- PredictorArn
-
O nome do recurso Amazon (ARN) do preditor.
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,
"DataConfig": {
"AdditionalDatasets": [
{
"Configuration": {
"string" : [ "string" ]
},
"Name": "string"
}
],
"AttributeConfigs": [
{
"AttributeName": "string",
"Transformations": {
"string" : "string"
}
}
],
"DatasetGroupArn": "string"
},
"DatasetImportJobArns": [ "string" ],
"EncryptionConfig": {
"KMSKeyArn": "string",
"RoleArn": "string"
},
"EstimatedTimeRemainingInMinutes": number,
"ExplainabilityInfo": {
"ExplainabilityArn": "string",
"Status": "string"
},
"ForecastDimensions": [ "string" ],
"ForecastFrequency": "string",
"ForecastHorizon": number,
"ForecastTypes": [ "string" ],
"LastModificationTime": number,
"Message": "string",
"MonitorInfo": {
"MonitorArn": "string",
"Status": "string"
},
"OptimizationMetric": "string",
"PredictorArn": "string",
"PredictorName": "string",
"ReferencePredictorSummary": {
"Arn": "string",
"State": "string"
},
"Status": "string",
"TimeAlignmentBoundary": {
"DayOfMonth": number,
"DayOfWeek": "string",
"Hour": number,
"Month": "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
-
O carimbo de data/hora da CreateAutoPredictor solicitação.
Tipo: carimbo de data/hora
- DataConfig
-
A configuração de dados do seu grupo de conjuntos de dados e de quaisquer conjuntos de dados adicionais.
Tipo: objeto DataConfig
- DatasetImportJobArns
-
Uma matriz dos trabalhos ARNs de importação do conjunto de dados usados para importar dados de treinamento para o preditor.
Tipo: Matriz de strings
Restrições de tamanho: o tamanho máximo é 256.
Padrão:
arn:([a-z\d-]+):forecast:.*:.*:.+ - EncryptionConfig
-
Uma chave AWS Key Management Service (KMS) e uma função AWS Identity and Access Management (IAM) que a Amazon Forecast pode assumir para acessar a chave. Você pode especificar esse objeto opcional nas solicitações CreateDataset e CreatePredictor.
Tipo: objeto EncryptionConfig
- EstimatedTimeRemainingInMinutes
-
O tempo estimado restante em minutos para a conclusão do trabalho de treinamento do preditor.
Tipo: longo
- ExplainabilityInfo
-
Fornece o status e a explicabilidade ARN do Predictor.
Tipo: objeto ExplainabilityInfo
- ForecastDimensions
-
Uma matriz de nomes de dimensões (campo) que especificam os atributos usados para agrupar as séries temporais.
Tipo: matriz de strings
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.
Padrão:
^[a-zA-Z][a-zA-Z0-9_]* - ForecastFrequency
-
A frequência das predições em uma previsão.
Os intervalos válidos são Y (Ano), M (Mês), W (Semana), D (Dia), H (Hora), 30min (30 minutos), 15min (15 minutos), 10min (10 minutos), 5min (5 minutos) e 1min (1 minuto). Por exemplo, “Y” indica todos os anos e “5min” indica a cada 5 minutos.
Tipo: string
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 5.
Padrão:
^Y|M|W|D|H|30min|15min|10min|5min|1min$ - ForecastHorizon
-
O número de etapas temporais que o modelo prevê. O horizonte de previsão também é chamado de comprimento da previsão.
Tipo: número inteiro
- ForecastTypes
-
Os tipos de previsão usados durante o treinamento do preditor. O valor padrão é [“0,1”, “0,5”, “0,9”].
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
-
No caso de um erro, uma mensagem detalhando a causa do erro.
Tipo: string
- MonitorInfo
-
Um MonitorInfo objeto com o Amazon Resource Name (ARN) e o status do recurso do monitor.
Tipo: objeto MonitorInfo
- OptimizationMetric
-
A métrica de precisão usada para otimizar o preditor.
Tipo: string
Valores Válidos:
WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE - PredictorArn
-
O nome do recurso Amazon (ARN) do preditor
Tipo: string
Restrições de tamanho: o tamanho máximo é 256.
Padrão:
arn:([a-z\d-]+):forecast:.*:.*:.+ - PredictorName
-
O nome do preditor.
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_]* - ReferencePredictorSummary
-
O estado ARN e do preditor de referência. Esse parâmetro só é válido para preditores treinados novamente ou atualizados.
Tipo: objeto ReferencePredictorSummary
- Status
-
O status do preditor. 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.
-
- TimeAlignmentBoundary
-
O limite de tempo que o Forecast usa ao agregar dados.
Tipo: objeto TimeAlignmentBoundary
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:
