ListUsers - AWS Transfer Family
Sintaxis de la solicitudParámetros de la solicitudSintaxis de la respuestaElementos de respuestaErroresEjemplosVéase también

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.

ListUsers

Muestra los usuarios de un servidor habilitado para el protocolo de File Transfer que especifique pasando el parámetro ServerId.

Sintaxis de la solicitud

{
   "MaxResults": number,
   "NextToken": "string",
   "ServerId": "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.

MaxResults

Especifica el número de usuarios que se devolverán como respuesta a la solicitud ListUsers.

Tipo: entero

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

Obligatorio: no

NextToken

Si hay resultados adicionales de la llamada ListUsers, se devuelve un parámetro NextToken en la salida. A continuación, puede pasar el NextToken a un comando ListUsers posterior para continuar con la lista de usuarios adicionales.

Tipo: cadena

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

Obligatorio: no

ServerId

Identificador único asignado por el sistema para un servidor que tiene usuarios asignados.

Tipo: cadena

Limitaciones de longitud: longitud fija de 19.

Patrón: s-([0-9a-f]{17})

Obligatorio: sí

Sintaxis de la respuesta

{
   "NextToken": "string",
   "ServerId": "string",
   "Users": [ 
      { 
         "Arn": "string",
         "HomeDirectory": "string",
         "HomeDirectoryType": "string",
         "Role": "string",
         "SshPublicKeyCount": number,
         "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.

NextToken

Cuando pueda obtener resultados adicionales de la llamada ListUsers, se devolverá un parámetro NextToken en la salida. A continuación, puede pasar un comando posterior al parámetro NextToken para seguir enumerando los usuarios adicionales.

Tipo: cadena

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

ServerId

Identificador único asignado por el sistema para un servidor al que están asignados los usuarios.

Tipo: cadena

Limitaciones de longitud: longitud fija de 19.

Patrón: s-([0-9a-f]{17})

Users

Devuelve los usuarios de Transfer Family y sus propiedades para el valor ServerId que especifique.

Tipo: matriz de objetos ListedUser

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

InvalidNextTokenException

El parámetro NextToken que se pasó no es válido.

HTTPCódigo de estado: 400

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

La ListUsers API llamada devuelve una lista de usuarios asociados al servidor que especifique.

Solicitud de muestra

     
         {
          "MaxResults": 100,
          "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
          "ServerId": "s-01234567890abcdef"
          }

Ejemplo

Este es un ejemplo de respuesta para esta API llamada.

Respuesta de ejemplo

{
   "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
   "ServerId": "s-01234567890abcdef",
   "Users": [ 
      { 
         "Arn": "arn:aws:transfer:us-east-1:176354371281:user/s-01234567890abcdef/charlie",
         "HomeDirectory": "/tests/home/charlie",
         "SshPublicKeyCount": 1,
         "Role": "arn:aws:iam::176354371281:role/transfer-role1",
         "Tags": [ 
            { 
               "Key": "Name",
               "Value": "user1"
            }
         ],
         "UserName": "my_user"
      }
   ]
}

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: