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

Amazon Forecast ya no está disponible para nuevos clientes. Los clientes actuales de Amazon Forecast pueden seguir utilizando el servicio con normalidad. Más informació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.

DescribeWhatIfAnalysis

Describe el análisis condicional creado mediante la operación CreateWhatIfAnalysis.

importante

Amazon Forecast ya no está disponible para nuevos clientes. Los clientes actuales de Amazon Forecast pueden seguir utilizando el servicio con normalidad. Más información

Además de enumerar las propiedades proporcionadas en la solicitud CreateWhatIfAnalysis, 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

{
   "WhatIfAnalysisArn": "string"
}

Parámetros de la solicitud

La solicitud acepta los siguientes datos en JSON formato.

WhatIfAnalysisArn

El nombre del recurso de Amazon (ARN) del análisis hipotético que le interesa.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

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

Obligatorio: sí

Sintaxis de la respuesta

{
   "CreationTime": number,
   "EstimatedTimeRemainingInMinutes": number,
   "ForecastArn": "string",
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string",
   "TimeSeriesSelector": { 
      "TimeSeriesIdentifiers": { 
         "DataSource": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "Format": "string",
         "Schema": { 
            "Attributes": [ 
               { 
                  "AttributeName": "string",
                  "AttributeType": "string"
               }
            ]
         }
      }
   },
   "WhatIfAnalysisArn": "string",
   "WhatIfAnalysisName": "string"
}

Elementos de respuesta

Si la acción se realiza correctamente, el servicio envía una respuesta de HTTP 200.

El servicio devuelve los siguientes datos en JSON formato.

CreationTime

Cuándo se creó el análisis condicional.

Tipo: marca temporal

EstimatedTimeRemainingInMinutes

El tiempo aproximado que queda para completar el análisis condicional, en minutos.

Tipo: largo

ForecastArn

El nombre del recurso de Amazon (ARN) de la previsión hipotética.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

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

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 del análisis 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 del análisis condicional debe ser ACTIVE para poder acceder al análisis.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

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

TimeSeriesSelector

Define el conjunto de series temporales que se utilizan para crear las previsiones en un objeto TimeSeriesIdentifiers.

El objeto TimeSeriesIdentifiers necesita la siguiente información:

  • DataSource

  • Format

  • Schema

Tipo: objeto TimeSeriesSelector

WhatIfAnalysisArn

El nombre del recurso de Amazon (ARN) del análisis hipotético.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

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

WhatIfAnalysisName

El nombre del análisis condicional.

Tipo: cadena

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.

HTTPCódigo de estado: 400

ResourceNotFoundException

No podemos encontrar un recurso con ese nombre de recurso de Amazon (ARN). Compruebe ARN y vuelva a intentarlo.

HTTPCódigo de estado: 400

Véase también

Para obtener más información sobre cómo usarlo API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente: