ListWhatIfAnalyses - 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.

ListWhatIfAnalyses

Devuelve una lista de análisis condicionales creados mediante la operación CreateWhatIfAnalysis. Para cada análisis 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 del análisis condicional con la operación DescribeWhatIfAnalysis.

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 IS o IS_NOT, que especifica si se deben incluir o excluir de la lista los trabajos de análisis condicional 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 son IS y IS_NOT. Para incluir los trabajos de análisis condicional que coinciden con la declaración, especifique IS. Para excluir los trabajos de análisis condicional coincidentes, especifique IS_NOT.

  • Key: el nombre del parámetro con el que se va a filtrar. Los valores válidos son WhatIfAnalysisArn y Status.

  • Value: el valor que debe coincidir.

Por ejemplo, para enumerar todos los trabajos que exportan un pronóstico denominado electricityWhatIf, especifique el siguiente filtro:

"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]

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",
   "WhatIfAnalyses": [ 
      { 
         "CreationTime": number,
         "ForecastArn": "string",
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string",
         "WhatIfAnalysisArn": "string",
         "WhatIfAnalysisName": "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 la respuesta está truncada, Forecast devuelve este token. Para recuperar el siguiente conjunto de resultados, utilice el token en la siguiente solicitud.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 3000.

Patrón: .+

WhatIfAnalyses

Matriz de objetos WhatIfAnalysisSummary que describen los análisis coincidentes.

Tipo: matriz de objetos WhatIfAnalysisSummary

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: