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

O guia completo de referência de API para Transfer Family está disponível em AWS Transfer Family API Reference.

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:

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 formatos do nome de recurso da Amazon (ARN) assumem a seguinte forma:

As entradas DNS (endpoints) em uso são assim:

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:

Como fazer solicitações de API

Além de usar o console, você pode usar a AWS Transfer Family API para configurar e gerenciar programaticamente seus servidores. Esta seção descreve as AWS Transfer Family operações, a assinatura de solicitações para autenticação e o tratamento de erros. Para obter mais informações sobre as regiões e os endpoints disponíveis para o Transfer Family, consulte AWS Transfer Family endpoints e quotas no Referência geral da AWS

Cabeçalhos de solicitação obrigatórios do Transfer Family

Esta seção descreve os cabeçalhos requeridos que você precisa enviar em cada solicitação POST ao AWS Transfer Family. Os cabeçalhos HTTP são incluídos para identificar as principais informações sobre a solicitação, como a operação que você deseja invocar, a data da solicitação e informações que indicam sua autorização como remetente da solicitação. Os cabeçalhos diferenciam minúsculas e maiúsculas e a ordem dos cabeçalhos não é importante.

O exemplo a seguir mostra os cabeçalhos que são usados na ListServersoperação.

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}

A seguir encontram-se os cabeçalhos que devem ser incluídos em suas solicitações POST ao Transfer Family. Os cabeçalhos mostrados abaixo que começam com “x-amz” são específicos para. AWS Todos os outros cabeçalhos listados são cabeçalhos comuns usados em transações HTTP.

Entradas e assinaturas de solicitações do Transfer Family

Todas as entradas da solicitação devem ser enviadas como parte da carga JSON no corpo da solicitação. Para ações em que todos os campos de solicitação são opcionais, por exemplo, ListServers, você ainda precisa fornecer um objeto JSON vazio no corpo da solicitação, como {}. A estrutura da carga útil do Transfer Family request/response está documentada na referência existente da API, por exemplo DescribeServer.

O Transfer Family oferece suporte à autenticação usando o AWS Signature Version 4. Para obter detalhes, veja Assinatura de solicitações da API da AWS.

Respostas de erro

Quando existe um erro, as informações no cabeçalho da resposta contêm:

O corpo de uma resposta de erro contém informações sobre o erro que ocorreu. A resposta de erro de exemplo a seguir mostra a sintaxe de saída dos elementos comuns a todas as respostas de erro.

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

A tabela a seguir explica os campos de resposta de erro JSON mostrados na sintaxe anterior.

Exemplos de resposta de erro

O corpo JSON a seguir será retornado se você chamar a API DescribeServer e especificar um servidor que não existe.

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

O corpo JSON a seguir será retornado se a execução de uma API causar o controle de utilização.

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

O corpo JSON a seguir será retornado se você usar a API CreateServer e não tiver permissões suficientes para criar um servidor do Transfer Family.

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

O corpo JSON a seguir será retornado se você chamar a API CreateUser e especificar um servidor que já existe.

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

Bibliotecas disponíveis

AWS fornece bibliotecas, exemplos de código, tutoriais e outros recursos para desenvolvedores de software que preferem criar aplicativos usando APIs específicas da linguagem em vez das ferramentas de linha de comando e da API de consulta. Essas bibliotecas oferecem as funções básicas (não incluídas nas APIs), como autenticação de solicitação, novas tentativas de solicitação e processamento de erros, para que você possa começar a usar com mais facilidade. Veja as ferramentas para desenvolver AWS

Para obter bibliotecas e código de exemplo em todos os idiomas, consulte Código de exemplo e bibliotecas.

Provedores de identidade

AWS Transfer Family oferece suporte a vários tipos de provedores de identidade para autenticar e gerenciar usuários. Cada servidor pode usar somente um método de autenticação, que deve ser selecionado quando o servidor é criado.

Para todos os métodos de autenticação, os usuários recebem políticas que definem seu acesso aos buckets do Amazon S3 ou aos sistemas de arquivos do Amazon Elastic File System. O servidor herda a relação de confiança do usuário por meio de uma função do IAM com uma AssumeRole ação, permitindo que ele execute operações de arquivo em nome do usuário.

Convenções de nomenclatura

AWS Transfer Family usa formatos padronizados para identificadores de recursos e Amazon Resource Names (ARNs). Compreender essas convenções é importante ao trabalhar com a AWS Transfer Family API.

Formatos de identificação

As seguintes convenções são observadas nos formatos de AWS Transfer Family ID:

Formatos ARN

Os formatos do nome de recurso da Amazon (ARN) assumem a seguinte forma:

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.

DNS e endpoints

AWS Transfer Family usa convenções de nomenclatura de DNS padronizadas para endpoints de API e endpoints de servidor. Compreender esses endpoints é essencial para configurar clientes e fazer chamadas de API.

Endpoints da API

Os endpoints de API são usados para fazer chamadas de API para gerenciar AWS Transfer Family recursos. Esses endpoints assumem as seguintes formas:

Endpoints do servidor

Os endpoints do servidor são usados pelos clientes de transferência de arquivos para se conectarem aos AWS Transfer Family servidores. Esses endpoints assumem as seguintes formas:

Para obter uma lista completa de AWS Transfer Family endpoints por AWS região, consulte os AWS Transfer Family endpoints e as cotas no. Referência geral da AWS