APIreferencia - AWS Transfer Family
Bienvenido

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.

APIreferencia

Las siguientes secciones documentan las llamadas AWS Transfer Family API al servicio, los tipos de datos, los parámetros y los errores.

Temas

Bienvenido a AWS Transfer Family API

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 transferencia de archivos Secure Shell (SSHSFTP)

  • Protocolo de transferencia de archivos seguro (FTPS)

  • Protocolo de transferencia de archivos (FTP)

  • Declaración de aplicabilidad (2) AS2

Los protocolos de transferencia de archivos se utilizan en los flujos de trabajo de intercambio de datos en diferentes industrias, como los servicios financieros, la atención médica, la publicidad y el comercio minorista, entre otros. AWS Transfer Family simplifica la migración de los flujos de trabajo de transferencia de archivos a AWS.

Para utilizar el AWS Transfer Family servicio, debe crear una instancia de un servidor en la AWS región que elija. Puede crear el servidor, ver una lista de los servidores disponibles, y actualizar servidores o eliminarlos. El servidor es la entidad desde la que se solicitan las operaciones con los archivos. AWS Transfer Family Los servidores tienen algunas propiedades muy importantes. El servidor es una instancia con nombre reconocible por un identificador ServerId asignado por el sistema. Si lo desea, puede asignar un nombre de host o incluso un nombre personalizado a un servidor. El servicio se factura por los servidores instanciados (incluso aquellos OFFLINE) y por el volumen de los datos transferidos.

Los usuarios deben ser conocidos por el servidor que solicita operaciones con archivos. Los usuarios, identificados por su nombre de usuario, se asignan a un servidor. Los nombres de usuario se utilizan para autenticar las solicitudes. Un mismo servidor solo puede tener un método de autenticación: AWS_DIRECTORY_SERVICE, SERVICE_MANAGED, AWS_LAMBDA o API_GATEWAY.

Puede usar cualquiera de los siguientes tipos de proveedores de identidad para autenticar a los usuarios:

  • SERVICE_MANAGEDEn efecto, una clave SSH pública se almacena junto con las propiedades del usuario en un servidor. Un usuario puede tener archivadas una o más claves SSH públicas para el método de SERVICE_MANAGED autenticación. Cuando un cliente solicita una operación de archivo como SERVICE_MANAGED método, proporciona el nombre de usuario y la clave SSH privada, que se autentican y se proporciona acceso.

  • Puede administrar la autenticación y el acceso de los usuarios con sus grupos de Microsoft Active Directory seleccionando el método de autenticación AWS_DIRECTORY_SERVICE.

  • Puede conectarse a un proveedor de identidad personalizado mediante AWS Lambda. Elija el método de autenticación AWS_LAMBDA.

  • Las solicitudes de los usuarios también pueden procesarse mediante un método de autenticación personalizado que ofrezca al mismo tiempo la autenticación del usuario y el acceso. Este método se basa en Amazon API Gateway para utilizar la API llamada de tu proveedor de identidad para validar las solicitudes de los usuarios. Este método se denomina «API_GATEWAYen API las llamadas» y «Personalizado» en la consola. Puede utilizar este método personalizado para autenticar usuarios en un servicio de directorio, en una base de datos de nombres y contraseñas o en algún otro mecanismo.

A los usuarios se les asigna una política con una relación de confianza entre ellos y un bucket de Amazon S3. El acceso puede ser a todo un bucket o a parte de él. Para que un servidor actúe en nombre de un usuario, el servidor debe heredar del usuario su relación de confianza. Se crea un rol AWS Identity and Access Management (IAM) que contiene la relación de confianza y a ese rol se le asigna una AssumeRole acción. Así el servidor puede llevar a cabo operaciones con archivos como si fuera el usuario.

Los usuarios que tengan establecida una propiedad de directorio home podrán hacer que ese directorio (o carpeta) actúe como destino u origen de las operaciones con archivos. Si no hay establecido un directorio home, la ubicación inicial es el directorio root del bucket.

Los servidores, los usuarios y las funciones se identifican por su nombre de recurso de Amazon (ARN). Puede asignar etiquetas, que son pares clave-valor, a 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 ID se respetan las siguientes convenciones:

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

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

Los formatos Amazon Resource Name (ARN) adoptan el siguiente formato:

  • En el caso de los ARNs servidores, utilice el formularioarn:aws:transfer:region:account-id:server/server-id.

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

  • Para los usuarios, ARNs toma el formularioarn:aws:transfer:region:account-id:user/server-id/username.

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

DNSlas entradas (puntos finales) que se utilizan son las siguientes:

  • APIlos puntos finales adoptan la forma. transfer.region.amazonaws.com

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

Para obtener una lista de los puntos de enlace de Transfer Family por AWS región, consulte los AWS Transfer Family puntos de enlace y las cuotas en. Referencia general de AWS

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

  • Para ver la lista alfabética de API acciones, consulte Actions.

  • Para ver la lista alfabética de los tipos de datos, consulte Data 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 realmente un comando, puede utilizar el --generate-cli-skeleton parámetro con cualquier API llamada 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.