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.
DescribePrincipalMapping
Describe el procesamiento dePUTyDELETEacciones para asignar usuarios a sus grupos. Esto incluye información sobre el estado de las acciones que se están procesando actualmente o aún por procesar, cuándo se actualizaron por última vez las acciones, cuándo Amazon Kendra recibió las acciones, la última acción que debe procesarse y aplicarse después de otras acciones y mensajes de error útiles si no se pudo procesar una acción.
DescribePrincipalMappingNo se admite actualmente en elAWSRegión GovCloud (EE. UU. Oeste).
Sintaxis de la solicitud
{
"DataSourceId": "string",
"GroupId": "string",
"IndexId": "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 de la fuente de datos para comprobar el procesamiento de
PUTyDELETEacciones para asignar usuarios a sus grupos.Type: Cadena
Restricciones 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 necesario para comprobar el procesamiento de
PUTyDELETEacciones para asignar usuarios a sus grupos.Type: Cadena
Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 1024 caracteres.
Patrón:
^\P{C}*$Obligatorio: Sí
- IndexId
-
El identificador del índice necesario para comprobar el procesamiento de
PUTyDELETEacciones para asignar usuarios a sus grupos.Type: Cadena
Restricciones de longitud: Longitud fija de 36.
Patrón:
[a-zA-Z0-9][a-zA-Z0-9-]*Obligatorio: Sí
Sintaxis de la respuesta
{
"DataSourceId": "string",
"GroupId": "string",
"GroupOrderingIdSummaries": [
{
"FailureReason": "string",
"LastUpdatedAt": number,
"OrderingId": number,
"ReceivedAt": number,
"Status": "string"
}
],
"IndexId": "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.
- DataSourceId
-
Muestra el identificador del origen de datos para ver información sobre el procesamiento de
PUTyDELETEacciones para asignar usuarios a sus grupos.Type: Cadena
Restricciones 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_-]* - GroupId
-
Muestra el identificador del grupo para ver información sobre el procesamiento de
PUTyDELETEacciones para asignar usuarios a sus grupos.Type: Cadena
Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 1024 caracteres.
Patrón:
^\P{C}*$ - GroupOrderingIdSummaries
-
Muestra la siguiente información sobre el procesamiento de
PUTyDELETEacciones para asignar usuarios a sus grupos:-
Estado: el estado puede ser
PROCESSING,SUCCEEDED,DELETING,DELETED, o bienFAILED. -
Última actualización: la última fecha y hora en que se actualizó una acción.
-
Recibido: la última fecha y hora en que se recibió o envió una acción.
-
ID de pedido: la última acción que debe procesarse y aplicarse después de otras acciones.
-
Razón de error: razón por la que una acción no se ha podido procesar.
Type: Matriz deGroupOrderingIdSummaryobjects
Miembros de matrices: Número máximo de 10 elementos.
-
- IndexId
-
Muestra el identificador del índice para ver información sobre el procesamiento de
PUTyDELETEacciones para asignar usuarios a sus grupos.Type: Cadena
Restricciones de longitud: Longitud fija de 36.
Patrón:
[a-zA-Z0-9][a-zA-Z0-9-]*
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:
