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 la 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:

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 formatos del nombre de recurso de Amazon (ARN) adoptan esta forma:

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

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:

Cómo realizar solicitudes a la API

Además de usar la consola, puede usar la AWS Transfer Family API para configurar y administrar sus servidores mediante programación. En esta sección se describen las AWS Transfer Family operaciones, la firma de solicitudes para la autenticación y la gestión de errores. Para obtener más información acerca de las regiones y los puntos de conexión disponibles para Transfer Family, consulte los puntos de conexión y cuotas de AWS Transfer Family en Referencia general de AWS.

Cabeceras de solicitud obligatorias para Transfer Family

En esta sección se describen los encabezados obligatorios que debe enviar con cada solicitud POST a AWS Transfer Family. Puede incluir encabezados HTTP para identificar información clave sobre la solicitud, incluidas la operación que desea invocar, la fecha de la solicitud y la información que indica su autorización como remitente de la solicitud. Los encabezados no distinguen entre mayúsculas y minúsculas y el orden de los encabezados no es importante.

El siguiente ejemplo muestra los encabezados que se utilizan en la ListServersoperación.

POST / HTTP/1.1
Host: transfer.us-east-1.amazonaws.com
x-amz-target: TransferService.ListServers
x-amz-date: 20220507T012034Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20220507/us-east-1/transfer/aws4_request,
    SignedHeaders=content-type;host;x-amz-date;x-amz-target,
    Signature=13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de
Content-Type: application/x-amz-json-1.1
Content-Length: 17

{"MaxResults":10}

Los siguientes son los encabezados que se deben incluir con las solicitudes POST a Transfer Family. Los encabezados que se muestran a continuación y que comienzan por «x-amz» son específicos de. AWS El resto de los encabezados que se muestran son encabezados comunes utilizados en transacciones HTTP.

Entrada y firma de la solicitud de Transfer Family

Todas las entradas de la solicitud deben enviarse como parte de la carga útil de JSON en el cuerpo de la solicitud. En el caso de las acciones en las que todos los campos de solicitud son opcionales, por ejemplo ListServers, tendrá que proporcionar un objeto JSON vacío en el cuerpo de la solicitud, por ejemplo, {}. La estructura de la carga útil de Transfer Family request/response está documentada, por ejemplo DescribeServer, en la referencia de la API existente.

Transfer Family admite la autenticación mediante AWS Signature Version 4. Para obtener más información, consulte Firmar solicitudes de API de AWS.

Respuestas de error

Cuando se produce un error, la información de encabezado de la respuesta contiene:

El cuerpo de una respuesta de error contiene información sobre el error que se ha producido. El siguiente ejemplo de respuesta de error muestra la sintaxis de salida de los elementos de respuesta comunes a todas las respuestas de error.

{
    "__type": "String",
    "Message": "String", <!-- Message is lowercase in some instances -->
    "Resource": "String",
    "ResourceType": "String",
    "RetryAfterSeconds": "String"
}

En la tabla siguiente se explican los campos de respuesta de error JSON que se muestran en la sintaxis anterior.

Ejemplos de respuestas de error

Si llama a la API de DescribeServer y especifica un servidor que no existe, se devuelve el siguiente cuerpo de JSON.

{
  "__type": "ResourceNotFoundException",
  "Message": "Unknown server",
  "Resource": "s-11112222333344444",
  "ResourceType": "Server"
}

Si la ejecución de una API provoca una limitación, se devuelve el siguiente cuerpo de JSON.

{
   "__type":"ThrottlingException",
   "RetryAfterSeconds":"1"
}

Si utiliza la API de CreateServer y no tiene permisos suficientes para crear un servidor de Transfer Family, se devuelve el siguiente cuerpo de JSON.

{
  "__type": "AccessDeniedException",
  "Message": "You do not have sufficient access to perform this action."
}

Si utiliza la API de CreateUser y especifica un usuario que ya existe, se devuelve el siguiente cuerpo de JSON.

{
  "__type": "ResourceExistsException",
  "Message": "User already exists",
  "Resource": "Alejandro-Rosalez",
  "ResourceType": "User"
}

Bibliotecas disponibles

AWS proporciona bibliotecas, códigos de muestra, tutoriales y otros recursos para los desarrolladores de software que prefieren crear aplicaciones mediante API específicas del idioma en lugar de las herramientas de línea de comandos y la API de Query. Estas bibliotecas proporcionan funciones básicas (que no se incluyen en las API), como la autenticación de solicitudes, los reintentos de solicitudes y la gestión de errores para que se pueda comenzar más fácilmente. Consulte Herramientas a partir de las cuales desarrollar AWS

Para ver las bibliotecas y código de ejemplo en todos los idiomas, consulte Código de muestra y bibliotecas.

Proveedores de identidad

AWS Transfer Family admite varios tipos de proveedores de identidad para autenticar y administrar los usuarios. Cada servidor solo puede usar un método de autenticación, que debe seleccionarse al crear el servidor.

Para todos los métodos de autenticación, a los usuarios se les asignan políticas que definen su acceso a los buckets de Amazon S3 o a los sistemas de archivos de Amazon Elastic File System. El servidor hereda la relación de confianza del usuario a través de un rol de IAM con una AssumeRole acción, lo que le permite realizar operaciones de archivos en nombre del usuario.

Convenciones de nomenclatura

AWS Transfer Family utiliza formatos estandarizados para los identificadores de recursos y los nombres de recursos de Amazon (ARN). Es importante comprender estas convenciones a la hora de trabajar con la AWS Transfer Family API.

Formatos de ID

En los formatos de AWS Transfer Family ID se respetan las siguientes convenciones:

Formatos ARN

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

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.

DNS y puntos finales

AWS Transfer Family utiliza convenciones de nomenclatura de DNS estandarizadas tanto para los puntos finales de la API como para los puntos finales del servidor. Comprender estos puntos finales es fundamental para configurar los clientes y realizar llamadas a la API.

Puntos de conexión de API

Los puntos finales de la API se utilizan para realizar llamadas a la API con el fin de gestionar los recursos AWS Transfer Family . Estos puntos finales adoptan las siguientes formas:

Puntos finales del servidor

Los clientes de transferencia de archivos utilizan los puntos finales del servidor para conectarse a AWS Transfer Family los servidores. Estos puntos finales adoptan las siguientes formas:

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