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.
DescribeUser
Describe el usuario asignado al servidor específico habilitado para el protocolo de transferencia de archivos, identificado por su propiedad ServerId.
La respuesta de esta llamada devuelve las propiedades del usuario asociadas al valor especificado ServerId.
Sintaxis de la solicitud
{
"ServerId": "string",
"UserName": "string"
}Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.
La solicitud acepta los siguientes datos en JSON formato.
- ServerId
-
Identificador único asignado por el sistema para un servidor que tiene asignado este usuario.
Tipo: cadena
Limitaciones de longitud: longitud fija de 19.
Patrón:
s-([0-9a-f]{17})Obligatorio: sí
- UserName
-
El nombre del usuario asignado a uno o más servidores. Los nombres de usuario forman parte de las credenciales de inicio de sesión para utilizar el AWS Transfer Family servicio y realizar tareas de transferencia de archivos.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 3. La longitud máxima es de 100 caracteres.
Patrón:
[\w][\w@.-]{2,99}Obligatorio: sí
Sintaxis de la respuesta
{
"ServerId": "string",
"User": {
"Arn": "string",
"HomeDirectory": "string",
"HomeDirectoryMappings": [
{
"Entry": "string",
"Target": "string",
"Type": "string"
}
],
"HomeDirectoryType": "string",
"Policy": "string",
"PosixProfile": {
"Gid": number,
"SecondaryGids": [ number ],
"Uid": number
},
"Role": "string",
"SshPublicKeys": [
{
"DateImported": number,
"SshPublicKeyBody": "string",
"SshPublicKeyId": "string"
}
],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"UserName": "string"
}
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta de HTTP 200.
El servicio devuelve los siguientes datos en JSON formato.
- ServerId
-
Identificador único asignado por el sistema para un servidor que tiene asignado este usuario.
Tipo: cadena
Limitaciones de longitud: longitud fija de 19.
Patrón:
s-([0-9a-f]{17}) - User
-
Matriz que contiene las propiedades del usuario Transfer Family para el valor
ServerIDque especificó.Tipo: objeto DescribedUser
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- InternalServiceError
-
Esta excepción se produce cuando se produce un error en el AWS Transfer Family servicio.
HTTPCódigo de estado: 500
- InvalidRequestException
-
Esta excepción se produce cuando el cliente envía una solicitud con un formato incorrecto.
HTTPCódigo de estado: 400
- ResourceNotFoundException
-
Esta excepción se produce cuando el servicio AWS Transfer Family no encuentra un recurso.
HTTPCódigo de estado: 400
- ServiceUnavailableException
-
La solicitud ha fallado porque el servicio AWS Transfer Family no está disponible.
HTTPCódigo de estado: 500
Ejemplos
Ejemplo
En el ejemplo siguiente se muestran los detalles de un usuario existente.
Solicitud de muestra
aws transfer describe-user --server-id s-1111aaaa2222bbbb3 --user-name bob-testRespuesta de ejemplo
{
"ServerId": "s-1111aaaa2222bbbb3",
"User": {
"Arn": "arn:aws:transfer:us-east-1:111122223333:user/s-1111aaaa2222bbbb3/bob-test",
"HomeDirectory": "/DOC-EXAMPLE-BUCKET",
"HomeDirectoryType": "PATH",
"Role": "arn:aws:iam::111122223333:role/bob-role",
"SshPublicKeys": [
{
"DateImported": "2022-03-31T12:27:52.614000-04:00",
"SshPublicKeyBody": "ssh-rsa AAAAB3NzaC1yc..... bobusa@mycomputer.us-east-1.amaazon.com",
"SshPublicKeyId": "key-abcde12345fghik67"
}
],
"Tags": [],
"UserName": "bob-test"
}
}Véase también
Para obtener más información sobre cómo usarlo API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
