As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# AWS Transfer Family Referência da API
<a name="api-welcome"></a>

O guia completo de referência de API para Transfer Family está disponível em [AWS Transfer Family API Reference](https://docs.aws.amazon.com/transfer/latest/APIReference/api-welcome.html). 

AWS Transfer Family é um serviço de transferência segura que você pode usar para transferir arquivos para dentro e para fora do armazenamento do Amazon Simple Storage Service (Amazon S3) usando os seguintes protocolos:
+ Protocolo de Transferência de Arquivos (SFTP) do Secure Shell (SSH)
+ Protocolo de Transferência de Arquivos Seguro (FTPS)
+ Protocolo de Transferência de Arquivos (FTP)
+ Declaração de Aplicabilidade 2 (AS2)

Servidores, usuários e funções são identificados pelo nome de recurso da Amazon (ARN). Você pode atribuir tags, que são pares de chave-valor, a entidades com um ARN. As tags são metadados que podem ser usados para agrupar ou procurar essas entidades. As tags são úteis, por exemplo, para fins de contabilidade.

As seguintes convenções são observadas nos formatos de AWS Transfer Family ID:
+ Os valores `ServerId` assumem a forma `s-01234567890abcdef`.
+ Os valores `SshPublicKeyId` assumem a forma `key-01234567890abcdef`.

Os formatos do nome de recurso da Amazon (ARN) assumem a seguinte forma:
+ Para servidores, os ARNs assumem a forma `arn:aws:transfer:{{region}}:{{account-id}}:server/{{server-id}}`.

  Veja o seguinte exemplo de um servidor ARN: `arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef`.
+ Para usuários, os ARNs assumem o formato `arn:aws:transfer:{{region}}:{{account-id}}:user/{{server-id}}/{{username}}`.

  Um exemplo é `arn:aws:transfer:us-east-1:123456789012:user/s-01234567890abcdef/user1`.

As entradas DNS (endpoints) em uso são assim:
+ Os endpoints de API assumem o formato `transfer.{{region}}.amazonaws.com`.
+ Os endpoints do servidor assumem o formato `server.transfer.{{region}}.amazonaws.com`.

Essa referência de interface de API AWS Transfer Family contém documentação para uma interface de programação que você pode usar para gerenciar AWS Transfer Family. A estrutura da referência é a seguinte:
+ Para uma lista alfabética de ações de API, consulte [https://docs.aws.amazon.com/transfer/latest/APIReference/API_Operations.html](https://docs.aws.amazon.com/transfer/latest/APIReference/API_Operations.html).
+ Para a lista alfabética de tipos de dados, consulte [https://docs.aws.amazon.com/transfer/latest/APIReference/API_Types.html](https://docs.aws.amazon.com/transfer/latest/APIReference/API_Types.html).
+ Para obter uma lista de parâmetros de consulta comuns, consulte [Parâmetros comuns](https://docs.aws.amazon.com/transfer/latest/APIReference/CommonParameters.html).
+ Para obter descrições dos códigos de erro, consulte [Erros comuns](https://docs.aws.amazon.com/transfer/latest/APIReference/CommonErrors.html).

**dica**  
Em vez de realmente executar um comando, você pode usar o parâmetro `--generate-cli-skeleton` com qualquer chamada de API para gerar e exibir um modelo de parâmetro. Em seguida, você pode usar o modelo gerado para personalizar e usar como entrada em um comando posterior. Para obter detalhes, consulte [Gerar e usar um arquivo esqueleto de parâmetro](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-skeleton.html#cli-usage-skeleton-generate).