ListQuerySuggestionsBlockLists - Amazon Kendra

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.

ListQuerySuggestionsBlockLists

Muestra las listas de bloques utilizadas para sugerencias de consultas de un índice.

Para obtener información sobre los límites de cuota actuales de las listas bloqueadas, consulteCuotas de Amazon Kendra.

ListQuerySuggestionsBlockListsNo se admite actualmente en elAWSRegión GovCloud (EE. UU. Oeste).

Sintaxis de la solicitud

{ "IndexId": "string", "MaxResults": number, "NextToken": "string" }

Parámetros de solicitud

Para obtener información sobre parámetros que son comunes a todas las acciones, consulteParámetros comunes.

La solicitud acepta los siguientes datos en formato JSON.

IndexId

Identificador del índice de una lista de todas las listas de bloques que existen para ese índice.

Para obtener información sobre los límites de cuota actuales de las listas bloqueadas, consulteCuotas de Amazon Kendra.

Type: Cadena

Restricciones de longitud: Longitud fija de 36.

Patrón: [a-zA-Z0-9][a-zA-Z0-9-]*

Obligatorio: Sí

MaxResults

El número máximo de listas de bloqueo que devolver.

Type: Entero

Rango válido: Valor mínimo de 1. Valor máximo de 100.

Obligatorio: No

NextToken

Si la respuesta anterior estaba incompleta (porque hay más datos que recuperar), Amazon Kendra devuelve un token de paginación en la respuesta. Puede utilizar este token de paginación para recuperar el siguiente conjunto de listas de bloqueo (BlockListSummaryItems).

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 800 caracteres.

Obligatorio: No

Sintaxis de la respuesta

{ "BlockListSummaryItems": [ { "CreatedAt": number, "Id": "string", "ItemCount": number, "Name": "string", "Status": "string", "UpdatedAt": number } ], "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.

BlockListSummaryItems

Elementos de resumen de una lista bloqueada.

Esto incluye elementos de resumen del ID de lista bloqueada, nombre de la lista de bloques, cuándo se creó la lista de bloques, cuándo se actualizó por última vez la lista de bloques y el recuento de palabras o frases en bloque de la lista de bloques.

Para obtener información sobre los límites de cuota actuales de las listas bloqueadas, consulteCuotas de Amazon Kendra.

Type: Matriz deQuerySuggestionsBlockListSummaryobjects

NextToken

Si la respuesta se trunca, Amazon Kendra devuelve este token que puede utilizar en la solicitud posterior para recuperar el siguiente conjunto de listas de bloqueo.

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 800 caracteres.

Errores

Para obtener información sobre errores que son comunes a todas las acciones, consulteErrores comunes.

AccessDeniedException

Código de estado HTTP: 400

InternalServerException

Código de estado HTTP: 500

ResourceNotFoundException

Código de estado HTTP: 400

ThrottlingException

Código de estado HTTP: 400

ValidationException

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: