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.
ListWhatIfForecasts
Devuelve una lista de las previsiones condicionales creadas mediante la operación CreateWhatIfForecast. Por cada previsión condicional, esta operación devuelve un resumen de sus propiedades, incluido su Nombre de recurso de Amazon (ARN). Puede recuperar el conjunto completo de propiedades mediante el ARN de previsión condicional con la operación DescribeWhatIfForecast.
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
{
"Filters": [
{
"Condition": "string",
"Key": "string",
"Value": "string"
}
],
"MaxResults": number,
"NextToken": "string"
}Parámetros de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- Filters
-
Matriz de filtros. Para cada filtro, proporcione una condición y una declaración de coincidencia. La condición es
ISoIS_NOT, que especifica si se deben incluir o excluir de la lista los trabajos de exportación de previsiones condicionales que coincidan con la declaración, respectivamente. La declaración de coincidencia consta de una clave y un valor.Propiedades del filtro
-
Condition: la condición que se debe aplicar. Los valores válidos sonISyIS_NOT. Para incluir los trabajos de exportación de previsiones que coincidan con la declaración, especifiqueIS. Para excluir los trabajos de exportación de previsiones coincidentes, especifiqueIS_NOT. -
Key: el nombre del parámetro con el que se va a filtrar. Los valores válidos sonWhatIfForecastArnyStatus. -
Value: el valor que debe coincidir.
Por ejemplo, para enumerar todos los trabajos que exportan una electricityWhatIfprevisión denominada Forecast, especifique el siguiente filtro:
"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast" } ]Tipo: matriz de objetos Filter
Obligatorio: no
-
- MaxResults
-
El número de artículos que se devuelve en la respuesta.
Tipo: entero
Rango válido: valor mínimo de 1. Valor máximo de 100.
Obligatorio: no
- NextToken
-
Si el resultado de la solicitud anterior se truncó, la respuesta incluye un
NextToken. Para recuperar el siguiente conjunto de resultados, utilice el token en la siguiente solicitud. Los tokens caducan tras 24 horas.Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 3000.
Patrón:
.+Obligatorio: no
Sintaxis de la respuesta
{
"NextToken": "string",
"WhatIfForecasts": [
{
"CreationTime": number,
"LastModificationTime": number,
"Message": "string",
"Status": "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.
- NextToken
-
Si el resultado de la solicitud anterior se truncó, la respuesta incluye un
NextToken. Para recuperar el siguiente conjunto de resultados, utilice el token en la siguiente solicitud. Los tokens caducan tras 24 horas.Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 3000.
Patrón:
.+ - WhatIfForecasts
-
Matriz de objetos
WhatIfForecastsque describen las previsiones coincidentes.Tipo: matriz de objetos WhatIfForecastSummary
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
- InvalidNextTokenException
-
El token no es válido. Los tokens caducan tras 24 horas.
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, consulta lo siguiente:
