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

ListExplainabilities

Devuelve una lista de los recursos de explicabilidad creados mediante la operación CreateExplainability. Esta operación devuelve un resumen de cada explicabilidad. Puede filtrar la lista mediante una matriz de objetos Filter.

Para recuperar el conjunto completo de propiedades de un recurso de explicabilidad concreto, utilice el ARN con la operación DescribeExplainability.

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 los recursos que coinciden con la declaración de la lista. 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.

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

  • Value: el valor que debe coincidir.

Tipo: matriz de objetos Filter

Obligatorio: no

MaxResults

Cantidad de artículos devueltos 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: string

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

Patrón: .+

Obligatorio: no

Sintaxis de la respuesta

{
   "Explainabilities": [ 
      { 
         "CreationTime": number,
         "ExplainabilityArn": "string",
         "ExplainabilityConfig": { 
            "TimePointGranularity": "string",
            "TimeSeriesGranularity": "string"
         },
         "ExplainabilityName": "string",
         "LastModificationTime": number,
         "Message": "string",
         "ResourceArn": "string",
         "Status": "string"
      }
   ],
   "NextToken": "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.

Explainabilities

Matriz de objetos que resumen las propiedades de cada recurso de explicabilidad.

Tipo: matriz de objetos ExplainabilitySummary

NextToken

Devuelve este token si la respuesta está truncada. Para recuperar el siguiente conjunto de resultados, utilice el token en la siguiente solicitud.

Tipo: string

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

Patrón: .+

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 AWS SDK específicos del idioma, consulta lo siguiente: