APIriferimento - AWS Transfer Family

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

APIriferimento

Le seguenti sezioni documentano le chiamate AWS Transfer Family API di servizio, i tipi di dati, i parametri e gli errori.

Benvenuto nella AWS Transfer Family API

AWS Transfer Family è un servizio di trasferimento sicuro che puoi utilizzare per trasferire file da e verso lo storage di Amazon Simple Storage Service (Amazon S3) tramite i seguenti protocolli:

  • Protocollo di trasferimento file Secure Shell (SSH) () SFTP

  • Protocollo di trasferimento file Secure (FTPS)

  • Protocollo di trasferimento file (FTP)

  • Dichiarazione di applicabilità (2) AS2

I protocolli di trasferimento dei file vengono utilizzati nei flussi di lavoro per lo scambio di dati in diversi settori come i servizi finanziari, la sanità, la pubblicità e la vendita al dettaglio, tra gli altri. AWS Transfer Family semplifica la migrazione dei flussi di lavoro di trasferimento dei file verso. AWS

Per utilizzare il AWS Transfer Family servizio, devi creare un'istanza di un server nella AWS regione di tua scelta. È possibile creare il server, elencare i server disponibili e aggiornare ed eliminare i server. Il server è l'entità a cui richiede le operazioni sui file AWS Transfer Family. I server dispongono di diverse proprietà importanti. Il server è un'istanza denominata come identificato da un identificatore ServerId assegnato dal sistema. Facoltativamente, puoi assegnare un nome host o anche un nome host personalizzato a un server. Le fatture del servizio per tutti i server istanziati (anche quelliOFFLINE) e per la quantità di dati trasferiti.

Gli utenti devono essere noti al server che richiede le operazioni sui file. Un utente identificato tramite il nome utente viene assegnato a un server. I nomi utente vengono utilizzati per autenticare le richieste. Un server può avere un solo metodo di autenticazione:AWS_DIRECTORY_SERVICE, SERVICE_MANAGEDAWS_LAMBDA, o. API_GATEWAY

È possibile utilizzare uno dei seguenti tipi di provider di identità per autenticare gli utenti:

  • InfattiSERVICE_MANAGED, una chiave SSH pubblica viene archiviata con le proprietà dell'utente su un server. Un utente può avere una o più chiavi SSH pubbliche in archivio per il metodo di SERVICE_MANAGED autenticazione. Quando un client richiede un'operazione su file per SERVICE_MANAGED method, fornisce il nome utente e la chiave SSH privata, che vengono autenticati e viene fornito l'accesso.

  • È possibile gestire l'autenticazione e l'accesso degli utenti con i gruppi di Microsoft Active Directory selezionando il metodo di AWS_DIRECTORY_SERVICE autenticazione.

  • È possibile connettersi a un provider di identità personalizzato utilizzando AWS Lambda. Scegli il metodo AWS_LAMBDA di autenticazione.

  • Puoi anche autenticare le richieste utente utilizzando un metodo di autenticazione personalizzato che fornisce autenticazione utente e accesso. Questo metodo si basa su Amazon API Gateway per utilizzare la API chiamata dal tuo provider di identità per convalidare le richieste degli utenti. Questo metodo viene chiamato «APIchiamate» e «Personalizzato» nella console. API_GATEWAY È possibile utilizzare questo metodo personalizzato per autenticare gli utenti rispetto a un servizio di directory, una coppia nome/password database o altri meccanismi.

Agli utenti viene assegnata una policy con una relazione di fiducia tra loro e un bucket Amazon S3. Potrebbero essere in grado di accedere a tutto o a una parte di un bucket. Affinché un server agisca per conto di un utente, deve ereditare la relazione di fiducia dall'utente. Viene creato un ruolo AWS Identity and Access Management (IAM) che contiene la relazione di trust e a tale ruolo viene assegnata un'AssumeRoleazione. Il server può quindi eseguire le operazioni sui file come se fosse l'utente.

Gli utenti che dispongono di un home set di proprietà di directory utilizzeranno tale directory (o cartella) come destinazione e origine delle operazioni sui file. Quando non è impostata una directory home, la directory root del bucket diventa la directory di destinazione.

Server, utenti e ruoli sono tutti identificati dal rispettivo Amazon Resource Name (ARN). Puoi assegnare tag, che sono coppie chiave-valore, a entità con un. ARN I tag sono metadati che possono essere utilizzati per raggruppare o cercare queste entità. Un esempio di utilizzo dei tag è per scopi di contabilità.

Nei formati AWS Transfer Family ID vengono rispettate le seguenti convenzioni:

  • I valori ServerId hanno il formato s-01234567890abcdef.

  • I valori SshPublicKeyId hanno il formato key-01234567890abcdef.

I formati Amazon Resource Name (ARN) assumono il seguente formato:

  • Per i server, ARNs compila il moduloarn:aws:transfer:region:account-id:server/server-id.

    Un esempio di server ARN è:arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef.

  • Per gli utenti, ARNs compila il moduloarn:aws:transfer:region:account-id:user/server-id/username.

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

DNSle voci (endpoint) in uso sono le seguenti:

  • APIgli endpoint assumono la forma. transfer.region.amazonaws.com

  • Gli endpoint del server hanno il formato server.transfer.region.amazonaws.com.

Per un elenco degli endpoint Transfer Family per AWS regione, consulta gli AWS Transfer Family endpoint e le quote in. Riferimenti generali di AWS

Questo riferimento all'APIinterfaccia AWS Transfer Family contiene la documentazione per un'interfaccia di programmazione che è possibile utilizzare per gestire. AWS Transfer Family La struttura di riferimento è la seguente:

  • Per l'elenco alfabetico delle API azioni, vedere Actions.

  • Per l'elenco alfabetico dei tipi di dati, vedere Data Types.

  • Per un elenco di parametri di query comuni, consulta la pagina Parametri Comuni.

  • Per le descrizioni dei codici di errore, consulta la pagina Errori comuni.

Suggerimento

Anziché eseguire effettivamente un comando, è possibile utilizzare il --generate-cli-skeleton parametro con qualsiasi API chiamata per generare e visualizzare un modello di parametro. È quindi possibile utilizzare il modello generato per personalizzarlo e utilizzarlo come input per un comando successivo. Per i dettagli, consultate Generare e utilizzare un file scheletro di parametri.