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.
ListProfiles
Devuelve una lista de los perfiles del sistema. Si desea limitar los resultados a un número determinado, introduzca un valor para el parámetro MaxResults. Si ejecutó el comando anteriormente y recibió un valor para NextToken, puede proporcionarlo para seguir enumerando los perfiles desde donde los dejó.
Sintaxis de la solicitud
{
"MaxResults": number,
"NextToken": "string",
"ProfileType": "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
-
Número máximo de perfiles que se devolverán.
Tipo: entero
Rango válido: valor mínimo de 1. Valor máximo de 1000.
Obligatorio: no
- NextToken
-
Cuando hay resultados adicionales que no se devolvieron, se devuelve un parámetro
NextToken. Puede usar ese valor en una llamada posterior aListProfilespara seguir publicando los resultados.Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 6144 caracteres.
Obligatorio: no
- ProfileType
-
Indica si se deben enumerar solo los perfiles de tipo
LOCALo solo los perfiles de tipoPARTNER. Si no se proporciona en la solicitud, el comando muestra todos los tipos de perfiles.Tipo: cadena
Valores válidos:
LOCAL | PARTNERObligatorio: no
Sintaxis de la respuesta
{
"NextToken": "string",
"Profiles": [
{
"Arn": "string",
"As2Id": "string",
"ProfileId": "string",
"ProfileType": "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
-
Devuelve un token que puede usar para volver a llamar a
ListProfilesy recibir resultados adicionales, si los hay.Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 6144 caracteres.
- Profiles
-
Devuelve una matriz en la que cada elemento contiene los detalles de un perfil.
Tipo: matriz de objetos ListedProfile
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
NextTokenque 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
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:
