DescribeWhatIfForecast - Amazon Forecast
Sintaxis de la solicitudParámetros de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

DescribeWhatIfForecast

Describe la previsión condicional creada mediante la operación CreateWhatIfForecast.

Además de enumerar las propiedades proporcionadas en la solicitud CreateWhatIfForecast, esta operación muestra las siguientes propiedades:

  • CreationTime

  • LastModificationTime

  • Message: si se produjo un error, la información sobre el error.

  • Status

Sintaxis de la solicitud

{
   "WhatIfForecastArn": "string"
}

Parámetros de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

WhatIfForecastArn

El nombre de recurso de Amazon (ARN) de la previsión condicional en la que está interesado.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 300.

Patrón: arn:([a-z\d-]+):forecast:.*:.*:.+

Obligatorio: sí

Sintaxis de la respuesta

{
   "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 respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

CreationTime

Cuándo se creó la previsión condicional.

Tipo: marca temporal

EstimatedTimeRemainingInMinutes

El tiempo aproximado que queda para completar la previsión condicional, en minutos.

Tipo: largo

ForecastTypes

Los cuantiles en los que se generan las previsiones probabilísticas. Puede especificar hasta cinco cuantiles por previsión condicional en la operación CreateWhatIfForecast. Si no especificó los cuantiles, los valores predeterminados son ["0.1", "0.5", "0.9"].

Tipo: matriz de cadenas

Miembros de la matriz: número mínimo de 1 artículo. Número máximo de 20 artículos.

Limitaciones de longitud: longitud mínima de 2. La longitud máxima es de 4 caracteres.

Patrón: (^0?\.\d\d?$|^mean$)

LastModificationTime

La última vez que se modificó el recurso. La marca temporal depende del estado del trabajo:

  • CREATE_PENDING: la CreationTime.

  • CREATE_IN_PROGRESS: marca temporal actual.

  • CREATE_STOPPING: marca temporal actual.

  • CREATE_STOPPED: cuándo se detuvo el trabajo.

  • ACTIVE o CREATE_FAILED: cuando el trabajo terminó o falló.

Tipo: marca temporal

Message

Si se produjo un error, el mensaje informativo sobre el error.

Tipo: cadena

Status

El estado de la previsión condicional. Los estados incluyen:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

nota

El Status de la previsión condicional debe ser ACTIVE para poder acceder a la previsión.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Patrón: ^[a-zA-Z0-9\_]+$

TimeSeriesReplacementsDataSource

Matriz de elementos S3Config, Schema y Format que describen la serie temporal de reemplazo.

Tipo: objeto TimeSeriesReplacementsDataSource

TimeSeriesTransformations

Matriz de elementos Action y TimeSeriesConditions que describen qué transformaciones se aplicaron a cada serie temporal.

Tipo: matriz de objetos TimeSeriesTransformation

Miembros de la matriz: número mínimo de 0 artículos. La cantidad máxima es de 30 artículos.

WhatIfAnalysisArn

El nombre de recurso de Amazon (ARN) del análisis condicional que contiene esta previsión.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Patrón: arn:([a-z\d-]+):forecast:.*:.*:.+

WhatIfForecastArn

El nombre de recurso de Amazon (ARN) de la previsión condicional.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 300.

Patrón: arn:([a-z\d-]+):forecast:.*:.*:.+

WhatIfForecastName

El nombre de la previsión condicional.

Tipo: string

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 63.

Patrón: ^[a-zA-Z][a-zA-Z0-9_]*

Errores

InvalidInputException

No podemos procesar la solicitud porque incluye un valor no válido o un valor que supera el rango válido.

Código de estado HTTP: 400

ResourceNotFoundException

No podemos encontrar un recurso con ese nombre de recurso de Amazon (ARN). Compruebe el ARN e inténtelo de nuevo.

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: