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

ListEntityPersonas

Muestra los permisos específicos de usuarios y grupos con acceso a tu experiencia de Amazon Kendra.

Sintaxis de la solicitud

{ "Id": "string", "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.

Id

Identificador de tu experiencia de Amazon Kendra.

Type: Cadena

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

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

Obligatorio: Sí

IndexId

El identificador del índice para tu experiencia 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 usuarios o grupos devueltos.

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 grupo de usuarios o grupos.

Type: Cadena

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

Obligatorio: No

Sintaxis de la respuesta

{ "NextToken": "string", "SummaryItems": [ { "CreatedAt": number, "EntityId": "string", "Persona": "string", "UpdatedAt": number } ] }

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 se trunca, Amazon Kendra devuelve este token, que puede utilizar en una solicitud posterior para recuperar el siguiente conjunto de usuarios o grupos.

Type: Cadena

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

SummaryItems

Matriz de información resumida para uno o más usuarios o grupos.

Type: Matrices dePersonasSummaryobjects

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: