ListAccesses - AWS Transfer Family
Sintaxis de la solicitudParámetros de la solicitudSintaxis de la respuestaElementos de respuestaErroresVé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.

ListAccesses

Muestra los detalles de todos los accesos que tiene en su servidor.

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 formato JSON.

MaxResults

Especifica el número máximo de SID de acceso que se van a devolver.

Tipo: entero

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

Obligatorio: no

NextToken

Cuando pueda obtener resultados adicionales de la llamada ListAccesses, 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 accesos adicionales.

Tipo: string

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

{
   "Accesses": [ 
      { 
         "ExternalId": "string",
         "HomeDirectory": "string",
         "HomeDirectoryType": "string",
         "Role": "string"
      }
   ],
   "NextToken": "string",
   "ServerId": "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.

Accesses

Devuelve los accesos y sus propiedades para el valor ServerId que especifique.

Tipo: matriz de objetos ListedAccess

NextToken

Cuando pueda obtener resultados adicionales de la llamada ListAccesses, 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 accesos adicionales.

Tipo: string

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 que tiene usuarios asignados.

Tipo: cadena

Limitaciones de longitud: longitud fija de 19.

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

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.

Código de estado HTTP: 500

InvalidNextTokenException

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

Código de estado HTTP: 400

InvalidRequestException

Esta excepción se produce cuando el cliente envía una solicitud con un formato incorrecto.

Código de estado HTTP: 400

ResourceNotFoundException

Esta excepción se produce cuando el servicio AWS Transfer Family no encuentra un recurso.

Código de estado HTTP: 400

ServiceUnavailableException

La solicitud ha fallado porque el servicio AWS Transfer Family no está disponible.

Código de estado HTTP: 500

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: