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á.
DescribeWhatIfForecastExport
Descreve a exportação de previsão de hipóteses por meio da operação CreateWhatIfForecastExport.
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 CreateWhatIfForecastExport, 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
{
"WhatIfForecastExportArn": "string"
}Parâmetros da solicitação
A solicitação aceita os dados a seguir no formato JSON.
- WhatIfForecastExportArn
-
O nome do recurso da Amazon (ARN) da exportação de previsão de hipóteses na qual você está interessado.
Tipo: string
Comprimentos de tamanho: comprimento máximo de 300.
Padrão:
arn:([a-z\d-]+):forecast:.*:.*:.+Exigido: Sim
Sintaxe da Resposta
{
"CreationTime": number,
"Destination": {
"S3Config": {
"KMSKeyArn": "string",
"Path": "string",
"RoleArn": "string"
}
},
"EstimatedTimeRemainingInMinutes": number,
"Format": "string",
"LastModificationTime": number,
"Message": "string",
"Status": "string",
"WhatIfForecastArns": [ "string" ],
"WhatIfForecastExportArn": "string",
"WhatIfForecastExportName": "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 exportação de previsão de hipóteses foi criada.
Tipo: carimbo de data/hora
- Destination
-
O destino de um trabalho de exportação. Forneça um caminho do S3, uma função AWS Identity and Access Management (IAM) que permite que o Amazon Forecast acesse o local e uma chave AWS Key Management Service (KMS) (opcional).
Tipo: objeto DataDestination
- EstimatedTimeRemainingInMinutes
-
O tempo aproximado restante para concluir a exportação da previsão de hipóteses, em minutos.
Tipo: longo
- Format
-
O formato dos dados exportados, CSV ou PARQUET.
Tipo: string
Restrições de Tamanho: O tamanho máximo é 7.
Padrão:
^CSV|PARQUET$ - 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
- 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
Statusda exportação de previsão de hipóteses deve serACTIVEpara que seja possível acessar a exportação de previsão.Tipo: string
Restrições de tamanho: o tamanho máximo é 256.
-
- WhatIfForecastArns
-
Uma matriz de nomes de recursos da Amazon (ARNs) que representam todas as previsões hipotéticas exportadas nesse recurso.
Tipo: matriz de strings
Restrições de tamanho: o tamanho máximo é 300.
Padrão:
arn:([a-z\d-]+):forecast:.*:.*:.+ - WhatIfForecastExportArn
-
O nome do recurso da Amazon (ARN) da exportação de previsão de hipóteses.
Tipo: string
Comprimentos de tamanho: comprimento máximo de 300.
Padrão:
arn:([a-z\d-]+):forecast:.*:.*:.+ - WhatIfForecastExportName
-
O nome da exportação de previsão de hipóteses a ser exportada.
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 uma das linguagens específicas AWS SDKs, consulte o seguinte:
