View a markdown version of this page

AWS Transfer Family Referencia de API - AWS Transfer Family

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.

AWS Transfer Family Referencia de API

La guía completa de referencia de API para Transfer Family está disponible en AWS Transfer Family API Reference.

AWS Transfer Family es un servicio de transferencia segura que puede utilizar para transferir archivos desde y hacia el almacenamiento del Amazon Simple Storage Service (Amazon S3) mediante los siguientes protocolos:

  • Protocolo de File Transfer (SFTP) Secure Shell (SSH)

  • Protocolo seguro de File Transfer (FTPS)

  • Protocolo de File Transfer (FTP)

  • Declaración de aplicabilidad 2 (AS2)

Los servidores, usuarios y roles se identifican por su nombre de recurso de Amazon (ARN). Puede asignar etiquetas, que son pares clave-valor, a las entidades con un ARN. Las etiquetas son metadatos que se pueden utilizar para agrupar o buscar estas entidades. Un ejemplo donde las etiquetas resultan útiles es en contabilidad.

En los formatos de AWS Transfer Family identificación se respetan las siguientes convenciones:

  • Los valores ServerId adoptan la forma s-01234567890abcdef.

  • Los valores SshPublicKeyId adoptan la forma key-01234567890abcdef.

Los formatos del nombre de recurso de Amazon (ARN) adoptan esta forma:

  • En el caso de los servidores, los ARN adoptan la forma arn:aws:transfer:region:account-id:server/server-id.

    Un ejemplo de ARN de un servidor es arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef.

  • En el caso de los usuarios, los ARN adoptan la forma arn:aws:transfer:region:account-id:user/server-id/username.

    Un ejemplo es arn:aws:transfer:us-east-1:123456789012:user/s-01234567890abcdef/user1.

Las entradas de DNS (puntos de conexión) en uso son:

  • Los puntos de enlace de la API adoptan la forma transfer.region.amazonaws.com.

  • Los puntos de enlace de servidor adoptan la forma server.transfer.region.amazonaws.com.

Esta referencia de interfaz API para AWS Transfer Family contiene documentación sobre una interfaz de programación que puede usar para administrar AWS Transfer Family. La estructura de la referencia es la siguiente:

  • Para obtener una lista alfabética de las acciones, consulte la Actions.

  • Para ver una lista de tipos de datos ordenada alfabéticamente, consulte Types.

  • Para ver una lista de parámetros de consulta comunes, consulte el tema relacionado con los parámetros comunes.

  • Para ver las descripciones de los códigos de error, consulte el tema relacionado con los errores comunes.

sugerencia

En lugar de ejecutar un comando, puede usar el parámetro --generate-cli-skeleton con cualquier llamada a la API para generar y mostrar una plantilla de parámetros. Después puede utilizar la plantilla generada para personalizarla y utilizarla como entrada en un comando posterior. Para más información, consulte Generar y usar un archivo básico de parámetros.