TestConnection - 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.

TestConnection

Comprueba si el SFTP conector está configurado correctamente. Le recomendamos encarecidamente que realice esta operación para comprobar su capacidad de transferir archivos entre el AWS almacenamiento local y el SFTP servidor de un socio comercial.

Sintaxis de la solicitud

{
   "ConnectorId": "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.

ConnectorId

Un identificador único para el conector.

Tipo: cadena

Limitaciones de longitud: longitud fija de 19.

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

Obligatorio: sí

Sintaxis de la respuesta

{
   "ConnectorId": "string",
   "Status": "string",
   "StatusMessage": "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.

ConnectorId

Devuelve el identificador del objeto conector que está probando.

Tipo: cadena

Limitaciones de longitud: longitud fija de 19.

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

Status

Devuelve OK la prueba se ha realizado correctamente o ERROR si la prueba no ha sido satisfactoria.

Tipo: cadena

StatusMessage

Devuelve Connection succeeded si la actualización se realiza correctamente. O bien, devuelve un mensaje de error descriptivo si la prueba no es satisfactoria. En la siguiente lista se proporcionan detalles sobre la solución de problemas, en función del mensaje de error que reciba.

  • Compruebe que su nombre secreto coincide con el de los permisos de Transfer Role.

  • Compruebe el servidor URL en la configuración del conector y compruebe que las credenciales de inicio de sesión funcionan correctamente fuera del conector.

  • Compruebe que el secreto existe y que tiene el formato correcto.

  • Compruebe que la clave de host de confianza de la configuración del conector coincide con la salida de ssh-keyscan.

Tipo: cadena

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

El siguiente ejemplo prueba la conexión a un servidor remoto.

aws transfer test-connection --connector-id c-abcd1234567890fff

Respuesta de ejemplo

Si se realiza correctamente, la API llamada devuelve los siguientes detalles.

{                                                                                                                                                             
    "Status": "OK",                                                                                                                                           
    "StatusMessage": "Connection succeeded"                                                                                                                   
}

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: