Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
StartFileTransfer
Commence un transfert de fichiers entre le AWS stockage local et une télécommande AS2 ou un SFTP serveur.
-
Pour un AS2 connecteur, vous devez spécifier le
ConnectorIdet ou plusieursSendFilePathspour identifier les fichiers que vous souhaitez transférer. -
Pour un SFTP connecteur, le transfert de fichiers peut être sortant ou entrant. Dans les deux cas, vous spécifiez le
ConnectorId. En fonction de la direction du transfert, vous spécifiez également les éléments suivants :-
Si vous transférez un fichier du SFTP serveur d'un partenaire vers le stockage Amazon Web Services, vous devez en spécifier un ou plusieurs
RetreiveFilePathspour identifier les fichiers que vous souhaitez transférer, et unLocalDirectoryPathpour spécifier le dossier de destination. -
Si vous transférez un fichier vers le SFTP serveur d'un partenaire depuis le AWS stockage, vous devez en spécifier un ou plusieurs
SendFilePathspour identifier les fichiers que vous souhaitez transférer, et unRemoteDirectoryPathpour spécifier le dossier de destination.
-
Syntaxe de la requête
{
"ConnectorId": "string",
"LocalDirectoryPath": "string",
"RemoteDirectoryPath": "string",
"RetrieveFilePaths": [ "string" ],
"SendFilePaths": [ "string" ]
}Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.
La demande accepte les données suivantes au JSON format suivant.
- ConnectorId
-
Identifiant unique du connecteur.
Type : String
Contraintes de longueur : longueur fixe de 19.
Modèle :
c-([0-9a-f]{17})Obligatoire : oui
- LocalDirectoryPath
-
Dans le cas d'un transfert entrant, le
LocaDirectoryPathspécifie la destination d'un ou de plusieurs fichiers transférés depuis le SFTP serveur du partenaire.Type : String
Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 1024.
Modèle :
(.)+Obligatoire : non
- RemoteDirectoryPath
-
Dans le cas d'un transfert sortant, le
RemoteDirectoryPathspécifie la destination d'un ou de plusieurs fichiers transférés vers le SFTP serveur du partenaire. Si vous ne spécifiez pas unRemoteDirectoryPath, la destination des fichiers transférés est le répertoire personnel de SFTP l'utilisateur.Type : String
Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 1024.
Modèle :
(.)+Obligatoire : non
- RetrieveFilePaths
-
Un ou plusieurs chemins source pour le SFTP serveur du partenaire. Chaque chaîne représente le chemin du fichier source pour un transfert de fichier entrant.
Type : tableau de chaînes
Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 10 éléments.
Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 1024.
Modèle :
(.)+Obligatoire : non
- SendFilePaths
-
Un ou plusieurs chemins source pour le stockage Amazon S3. Chaque chaîne représente le chemin du fichier source pour un transfert de fichier sortant. Par exemple,
DOC-EXAMPLE-BUCKET/myfile.txt.Note
DOC-EXAMPLE-BUCKETRemplacez-le par l'un de vos seaux actuels.Type : tableau de chaînes
Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 10 éléments.
Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 1024.
Modèle :
(.)+Obligatoire : non
Syntaxe de la réponse
{
"TransferId": "string"
}Eléments de réponse
Si l'action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées sous JSON forme formatée par le service.
- TransferId
-
Renvoie l'identifiant unique pour le transfert de fichier.
Type : String
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 512.
Modèle :
[0-9a-zA-Z./-]+
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.
- InternalServiceError
-
Cette exception est levée lorsqu'une erreur se produit dans le AWS Transfer Family service.
HTTPCode de statut : 500
- InvalidRequestException
-
Cette exception est levée lorsque le client soumet une demande mal formée.
HTTPCode de statut : 400
- ResourceNotFoundException
-
Cette exception est levée lorsqu'aucune ressource n'est trouvée par le service AWS Transfer Family.
HTTPCode de statut : 400
- ServiceUnavailableException
-
La demande a échoué car le service AWS Transfer Family n'est pas disponible.
HTTPCode de statut : 500
- ThrottlingException
-
La demande a été refusée suite à une limitation des demandes.
HTTPCode de statut : 400
Exemples
Exemple
L'exemple suivant lance un transfert de AS2 fichier depuis un serveur Transfer Family vers le terminal d'un partenaire commercial distant.
DOC-EXAMPLE-BUCKET
Remplacez-le par l'un de vos seaux actuels.
Exemple de demande
{
"ConnectorId": "c-AAAA1111BBBB2222C",
"SendFilePaths": [
"/DOC-EXAMPLE-BUCKET/myfile-1.txt",
"/DOC-EXAMPLE-BUCKET/myfile-2.txt",
"/DOC-EXAMPLE-BUCKET/myfile-3.txt"
]
}Exemple de réponse
{
"TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}Exemple
L'exemple suivant lance un transfert de fichier depuis le AWS stockage local vers un SFTP serveur distant.
Exemple de demande
{
"ConnectorId": "c-01234567890abcdef",
"SendFilePaths": [
"/DOC-EXAMPLE-BUCKET/myfile-1.txt",
"/DOC-EXAMPLE-BUCKET/myfile-2.txt",
"/DOC-EXAMPLE-BUCKET/myfile-3.txt"
],
"RemoteDirectoryPath": "/MySFTPRootFolder/fromTranferFamilyServer"
}Exemple de réponse
{
"TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}Exemple
L'exemple suivant lance un transfert de fichier d'un SFTP serveur distant vers le AWS stockage local.
Exemple de demande
{
"ConnectorId": "c-111122223333AAAAA",
"RetrieveFilePaths": [
"/MySFTPFolder/toTranferFamily/myfile-1.txt",
"/MySFTPFolder/toTranferFamily/myfile-2.txt",
"/MySFTPFolder/toTranferFamily/myfile-3.txt"
],
"LocalDirectoryPath": "/DOC-EXAMPLE-BUCKET/mySourceFiles"
}Exemple de réponse
{
"TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa"
}consultez aussi
Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :
