DescribeWhatIfForecast - Amazon Forecast
Sintaxe da SolicitaçãoParâmetros da solicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

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á.

DescribeWhatIfForecast

Descreve a previsão de hipóteses por meio da operação CreateWhatIfForecast.

Além de listar as propriedades fornecidas na solicitação CreateWhatIfForecast, essa operação inclui as seguintes propriedades:

  • CreationTime

  • LastModificationTime

  • Message: se ocorreu um erro, as informações sobre o erro.

  • Status

Sintaxe da Solicitação

{
   "WhatIfForecastArn": "string"
}

Parâmetros da solicitação

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

WhatIfForecastArn

O nome do recurso da Amazon (ARN) da previsão de hipóteses de interesse.

Tipo: string

Comprimentos de tamanho: comprimento máximo de 300.

Padrão: arn:([a-z\d-]+):forecast:.*:.*:.+

Exigido: Sim

Sintaxe da Resposta

{
   "CreationTime": number,
   "EstimatedTimeRemainingInMinutes": number,
   "ForecastTypes": [ "string" ],
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string",
   "TimeSeriesReplacementsDataSource": { 
      "Format": "string",
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      },
      "Schema": { 
         "Attributes": [ 
            { 
               "AttributeName": "string",
               "AttributeType": "string"
            }
         ]
      },
      "TimestampFormat": "string"
   },
   "TimeSeriesTransformations": [ 
      { 
         "Action": { 
            "AttributeName": "string",
            "Operation": "string",
            "Value": number
         },
         "TimeSeriesConditions": [ 
            { 
               "AttributeName": "string",
               "AttributeValue": "string",
               "Condition": "string"
            }
         ]
      }
   ],
   "WhatIfAnalysisArn": "string",
   "WhatIfForecastArn": "string",
   "WhatIfForecastName": "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 a previsão de hipóteses foi criada.

Tipo: carimbo de data/hora

EstimatedTimeRemainingInMinutes

O tempo aproximado restante para concluir a previsão de hipóteses, em minutos.

Tipo: longo

ForecastTypes

Os quantis nos quais as previsões probabilísticas são geradas. É possível especificar até cinco quantis por previsão de hipóteses na operação CreateWhatIfForecast. Se você não especificou quantis, os valores padrão serã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: 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

Se ocorreu um erro, uma mensagem informativa sobre o erro.

Tipo: string

Status

O status da previsão de hipóteses. 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 Status da previsão de hipóteses deve ser ACTIVE antes que você possa acessar a previsão.

Tipo: string

Restrições de tamanho: o tamanho máximo é 256.

Padrão: ^[a-zA-Z0-9\_]+$

TimeSeriesReplacementsDataSource

Uma matriz de elementos S3Config, Schema e Format que descrevem a série temporal de substituição.

Tipo: objeto TimeSeriesReplacementsDataSource

TimeSeriesTransformations

Uma matriz de elementos Action e TimeSeriesConditions que descrevem quais transformações foram aplicadas a quais séries temporais.

Tipo: matriz de objetos TimeSeriesTransformation

Membros da Matriz: número mínimo de 0 itens. Número máximo de 30 itens.

WhatIfAnalysisArn

O nome do recurso da Amazon (ARN) da análise de hipóteses que contém a previsão.

Tipo: string

Restrições de tamanho: o tamanho máximo é 256.

Padrão: arn:([a-z\d-]+):forecast:.*:.*:.+

WhatIfForecastArn

O nome do recurso da Amazon (ARN) da previsão de hipóteses.

Tipo: string

Comprimentos de tamanho: comprimento máximo de 300.

Padrão: arn:([a-z\d-]+):forecast:.*:.*:.+

WhatIfForecastName

O nome da previsão de hipóteses.

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_]*

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: