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.
DescribeAutoPredictor
Describe un predictor creado mediante la CreateAutoPredictor operación.
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
Sintaxis de la solicitud
{
"PredictorArn": "string"
}Parámetros de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- PredictorArn
-
El nombre de recurso de Amazon (ARN) del predictor.
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,
"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 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
-
La marca de tiempo de la CreateAutoPredictor solicitud.
Tipo: marca temporal
- DataConfig
-
La configuración de datos de su grupo de conjuntos de datos y de cualquier conjunto de datos adicional.
Tipo: objeto DataConfig
- DatasetImportJobArns
-
Una matriz de los trabajos de importación ARNs del conjunto de datos que se utilizan para importar los datos de entrenamiento para el predictor.
Tipo: matriz de cadenas
Limitaciones de longitud: longitud máxima de 256.
Patrón:
arn:([a-z\d-]+):forecast:.*:.*:.+ - EncryptionConfig
-
Una clave AWS Key Management Service (KMS) y una función AWS Identity and Access Management (IAM) que Amazon Forecast puede asumir para acceder a la clave. Puede especificar este objeto opcional en las solicitudes CreateDataset y CreatePredictor.
Tipo: objeto EncryptionConfig
- EstimatedTimeRemainingInMinutes
-
El tiempo estimado que queda en minutos para que finalice el trabajo de entrenamiento del predictor.
Tipo: largo
- ExplainabilityInfo
-
Proporciona el estado y el ARN de la explicabilidad del predictor.
Tipo: objeto ExplainabilityInfo
- ForecastDimensions
-
Matriz de nombres de dimensiones (campos) que especifican los atributos utilizados para agrupar las series temporales.
Tipo: matriz de cadenas
Miembros de la matriz: número mínimo de 1 artículo. Número máximo de 10 artículos.
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 63.
Patrón:
^[a-zA-Z][a-zA-Z0-9_]* - ForecastFrequency
-
La frecuencia de las predicciones de una previsión.
Los intervalos válidos son Y (año), M (mes), W (semana), D (día), H (hora), 30min (30 minutos), 15min (15 minutos), 10min (10 minutos), 5min (5 minutos) y 1min (1 minuto). Por ejemplo, “Y” indica todos los años y “5min” indica cada cinco minutos.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 5.
Patrón:
^Y|M|W|D|H|30min|15min|10min|5min|1min$ - ForecastHorizon
-
El número de pasos de tiempo que el modelo predice. El horizonte de previsión también se denomina longitud de predicción.
Tipo: entero
- ForecastTypes
-
Los tipos de previsión usados durante el entrenamiento del predictor. El valor predeterminado es ["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: laCreationTime. -
CREATE_IN_PROGRESS: marca temporal actual. -
CREATE_STOPPING: marca temporal actual. -
CREATE_STOPPED: cuándo se detuvo el trabajo. -
ACTIVEoCREATE_FAILED: cuando el trabajo terminó o falló.
Tipo: marca temporal
-
- Message
-
En caso de error, un mensaje que detalle la causa del error.
Tipo: cadena
- MonitorInfo
-
Un objeto MonitorInfo con el nombre de recurso de Amazon (ARN) y el estado del recurso de monitor.
Tipo: objeto MonitorInfo
- OptimizationMetric
-
La métrica de precisión utilizada para optimizar el predictor.
Tipo: cadena
Valores válidos:
WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE - PredictorArn
-
El nombre de recurso de Amazon (ARN) del predictor.
Tipo: cadena
Limitaciones de longitud: longitud máxima de 256.
Patrón:
arn:([a-z\d-]+):forecast:.*:.*:.+ - PredictorName
-
El nombre del predictor.
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_]* - ReferencePredictorSummary
-
El ARN y el estado del predictor de referencia. Este parámetro solo es válido para los predictores reentrenados o actualizados.
Tipo: objeto ReferencePredictorSummary
- Status
-
El estado del predictor. Los estados incluyen:
-
ACTIVE -
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILED -
CREATE_STOPPING,CREATE_STOPPED -
DELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
Tipo: cadena
Limitaciones de longitud: longitud máxima de 256.
-
- TimeAlignmentBoundary
-
El límite de tiempo que Forecast utiliza al agregar datos.
Tipo: objeto TimeAlignmentBoundary
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 idiomas específicos AWS SDKs, consulte lo siguiente:
