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

PutPrincipalMapping

Asigna usuarios a sus grupos para que solo tenga que proporcionar el ID de usuario cuando emite la consulta.

También puede asignar subgrupos a grupos. Por ejemplo, el grupo «Equipos de propiedad intelectual de la empresa» incluye subgrupos «Investigación» e «Ingeniería». Estos subgrupos incluyen su propia lista de usuarios o personas que trabajan en estos equipos. Solo los usuarios que trabajan en investigación e ingeniería y, por lo tanto, pertenecen al grupo de propiedad intelectual, pueden ver los documentos de la empresa de alto secreto en sus resultados de búsqueda.

Esto resulta útil para el filtrado de contexto de usuario, donde los resultados de búsqueda se filtran en función del acceso del usuario o de su grupo a los documentos. Para obtener más información, consulte Filtrado en contexto de usuario.

Si hay más de cincoPUTlas acciones de un grupo se están procesando actualmente, se produce una excepción de validación.

PutPrincipalMappingNo se admite actualmente en elAWS GovCloud (EE.UU.-Oeste).

Sintaxis de la solicitud

{ "DataSourceId": "string", "GroupId": "string", "GroupMembers": { "MemberGroups": [ { "DataSourceId": "string", "GroupId": "string" } ], "MemberUsers": [ { "UserId": "string" } ], "S3PathforGroupMembers": { "Bucket": "string", "Key": "string" } }, "IndexId": "string", "OrderingId": number, "RoleArn": "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.

DataSourceId

Identificador del origen de datos que desea asignar usuarios a sus grupos.

Esto resulta útil si un grupo está vinculado a varios orígenes de datos, pero solo desea que el grupo acceda a los documentos de un origen de datos determinado. Por ejemplo, los grupos «Investigación», «Ingeniería» y «Ventas y marketing» están vinculados a los documentos de la empresa almacenados en las fuentes de datos Confluence y Salesforce. Sin embargo, el equipo de «Ventas y marketing» solo necesita acceso a los documentos relacionados con el cliente almacenados en Salesforce.

Type: Cadena

Limitaciones de longitud: Longitud mínima de 1. La longitud máxima es de 100. caracteres.

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

Obligatorio: No

GroupId

Identificador del grupo al que desea asignar a sus usuarios.

Type: Cadena

Limitaciones de longitud: Longitud mínima de 1. La longitud máxima es de 1024 caracteres.

Patrón: ^\P{C}*$

Obligatorio: Sí

GroupMembers

La lista que contiene los usuarios o subgrupos que pertenecen al mismo grupo.

Por ejemplo, el grupo «Empresa» incluye al usuario «CEO» y los subgrupos «Investigación», «Ingeniería» y «Ventas y marketing».

Si tiene más de 1000 usuarios y/o subgrupos para un solo grupo, debe proporcionar la ruta al archivo S3 que enumera los usuarios y los subgrupos de un grupo. Los subgrupos pueden contener más de 1000 usuarios, pero la lista de subgrupos que pertenecen a un grupo (y/o usuarios) no debe ser superior a 1000.

Tipo: objeto GroupMembers

Obligatorio: Sí

IndexId

Identificador del índice que desea asignar usuarios a sus grupos.

Type: Cadena

Limitaciones de longitud: Longitud fija de 36.

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

Obligatorio: Sí

OrderingId

El identificador de marca de hora que especifique para asegurarse de que Amazon Kendra no invalide la últimaPUTacción con acciones anteriores. El ID de número más alto, que es el ID de pedido, es la última acción que desea procesar y aplicar encima de otras acciones con ID de número inferior. Esto impide que las acciones anteriores con ID de número menor sustituyan posiblemente la última acción.

El identificador de pedido puede ser la hora UNIX de la última actualización que realizó en una lista de miembros del grupo. A continuación, proporcionaría esta lista al llamarPutPrincipalMapping. Esto garantiza que suPUTla acción de ese grupo actualizado con la última lista de miembros no se sobrescribe antesPUTacciones para el mismo grupo que aún no se han procesado.

El identificador de pedido predeterminado es el tiempo UNIX actual en milisegundos que Amazon Kendra recibió la acción.

Type: Largo

Rango válido: Valor mínimo de 0. Valor máximo de 32535158400000.

Obligatorio: No

RoleArn

El nombre de recurso de Amazon (ARN) de un rol que tiene acceso al archivo de S3 que contiene la lista de usuarios o subgrupos que pertenecen a un grupo.

Para obtener más información, consulteRoles de IAM para Amazon Kendra.

Type: Cadena

Limitaciones de longitud: Longitud mínima de 0. Longitud máxima de 1284.

Patrón: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Obligatorio: No

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200 con un cuerpo HTTP vacío.

Errores

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

AccessDeniedException

Código de estado HTTP: 400

ConflictException

Código de estado HTTP: 400

InternalServerException

Código de estado HTTP: 500

ResourceNotFoundException

Código de estado HTTP: 400

ServiceQuotaExceededException

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: