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.
CreateConnector
Crée le connecteur, qui capture les paramètres d'une connexion pour le SFTP protocole AS2 or. En AS2 effet, le connecteur est nécessaire pour envoyer des fichiers à un AS2 serveur hébergé en externe. En SFTP effet, le connecteur est nécessaire pour envoyer des fichiers à un SFTP serveur ou recevoir des fichiers d'un SFTP serveur. Pour plus de détails sur les connecteurs, reportez-vous aux sections Configuration des AS2 connecteurs et Création de SFTP connecteurs.
Note
Vous devez spécifier exactement un objet de configuration : for AS2 (As2Config) ou SFTP (SftpConfig).
Syntaxe de la requête
{
"AccessRole": "string",
"As2Config": {
"BasicAuthSecretId": "string",
"Compression": "string",
"EncryptionAlgorithm": "string",
"LocalProfileId": "string",
"MdnResponse": "string",
"MdnSigningAlgorithm": "string",
"MessageSubject": "string",
"PartnerProfileId": "string",
"SigningAlgorithm": "string"
},
"LoggingRole": "string",
"SftpConfig": {
"TrustedHostKeys": [ "string" ],
"UserSecretId": "string"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"Url": "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.
- AccessRole
-
Les connecteurs sont utilisés pour envoyer des fichiers en utilisant le SFTP protocole AS2 or. Pour le rôle d'accès, indiquez le nom de ressource Amazon (ARN) du AWS Identity and Access Management rôle à utiliser.
Pour AS2 connecteurs
AvecAS2, vous pouvez envoyer des fichiers en appelant
StartFileTransferet en spécifiant les chemins des fichiers dans le paramètre de requête,SendFilePaths. Nous utilisons le répertoire parent du fichier (par exemple, car--send-file-paths /bucket/dir/file.txt, le répertoire parent est/bucket/dir/) pour stocker temporairement un fichier de AS2 message traité, le stocker MDN lorsque nous le recevons du partenaire et écrire un JSON fichier final contenant les métadonnées pertinentes de la transmission. Ainsi, leAccessRoledoit fournir un accès en lecture et en écriture au répertoire parent de l'emplacement du fichier utilisé dans la requêteStartFileTransfer. En outre, vous devez fournir un accès en lecture et en écriture au répertoire parent des fichiers que vous souhaitez envoyer avecStartFileTransfer.Si vous utilisez l'authentification de base pour votre AS2 connecteur, le rôle d'accès nécessite l'
secretsmanager:GetSecretValueautorisation d'accès au secret. Si le secret est chiffré à l'aide d'une clé gérée par le client au lieu de la clé AWS gérée dans Secrets Manager, le rôle doit également disposer d'unekms:Decryptautorisation pour cette clé.Pour SFTP connecteurs
Assurez-vous que le rôle d'accès fournit un accès en lecture et en écriture au répertoire parent de l'emplacement du fichier utilisé dans la
StartFileTransferdemande. Assurez-vous également que le rôle fournit l'secretsmanager:GetSecretValueautorisation de AWS Secrets Manager.Type : String
Contraintes de longueur : longueur minimale de 20. Longueur maximale de 2048.
Modèle :
arn:.*role/\S+Obligatoire : oui
- As2Config
-
Structure contenant les paramètres d'un objet AS2 connecteur.
Type : objet As2ConnectorConfig
Obligatoire : non
- LoggingRole
-
Nom de ressource Amazon (ARN) du rôle AWS Identity and Access Management (IAM) qui permet à un connecteur d'activer la CloudWatch journalisation des événements Amazon S3. Lorsque cette option est configurée, vous pouvez consulter l'activité du connecteur dans vos CloudWatch journaux.
Type : String
Contraintes de longueur : longueur minimale de 20. Longueur maximale de 2048.
Modèle :
arn:.*role/\S+Obligatoire : non
- SftpConfig
-
Structure contenant les paramètres d'un objet SFTP connecteur.
Type : objet SftpConnectorConfig
Obligatoire : non
- Tags
-
Paires clé-valeur qui peuvent être utilisées pour regrouper et rechercher des connecteurs. Les balises sont des métadonnées attachées aux connecteurs pour n'importe quel usage.
Type : tableau d’objets Tag
Membres du tableau : Nombre minimum de 1 élément. Nombre maximal de 50 éléments.
Obligatoire : non
- Url
-
Celui URL du partenaire AS2 ou du SFTP point final.
Type : String
Contraintes de longueur : longueur minimum de 0. Longueur maximale de 255.
Obligatoire : oui
Syntaxe de la réponse
{
"ConnectorId": "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.
- ConnectorId
-
Identifiant unique du connecteur, renvoyé une fois l'APIappel réussi.
Type : String
Contraintes de longueur : longueur fixe de 19.
Modèle :
c-([0-9a-f]{17})
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
- ResourceExistsException
-
La ressource demandée n'existe pas ou existe dans une région autre que celle spécifiée pour la commande.
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 crée un AS2 connecteur. Dans la commande, remplacez les éléments comme suit :
-
url: fournissez URL le AS2 serveur du partenaire commercial. -
your-IAM-role-for-bucket-access: un IAM rôle qui a accès au compartiment Amazon S3 que vous utilisez pour stocker vos fichiers. -
Utilisez le ARN pour votre rôle de journalisation, qui inclut votre Compte AWS identifiant.
-
Indiquez le chemin d'un fichier contenant les paramètres de configuration du AS2 connecteur. L'objet de configuration AS2 du connecteur est décrit dans As2. ConnectorConfig
// Listing for testAs2Config.json { "LocalProfileId": "your-profile-id", "PartnerProfileId": "partner-profile-id", "MdnResponse": "SYNC", "Compression": "ZLIB", "EncryptionAlgorithm": "AES256_CBC", "SigningAlgorithm": "SHA256", "MdnSigningAlgorithm": "DEFAULT", "MessageSubject": "Your Message Subject" }
aws transfer create-connector --url "http://partner-as2-server-url" \ --access-role your-IAM-role-for-bucket-access \ --logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \ --as2-config file://path/to/testAS2Config.json
Exemple
L'exemple suivant crée un SFTP connecteur. Dans la commande, remplacez les éléments comme suit :
-
sftp-server-url: indiquez URL le SFTP serveur avec lequel vous échangez des fichiers. -
your-IAM-role-for-bucket-access: un IAM rôle qui a accès au compartiment Amazon S3 que vous utilisez pour stocker vos fichiers. -
Utilisez le ARN pour votre rôle de journalisation, qui inclut votre Compte AWS identifiant.
-
Indiquez le chemin d'un fichier contenant les paramètres de configuration du SFTP connecteur. L'objet de configuration du SFTP connecteur est décrit dans SftpConnectorConfig.
// Listing for testSFTPConfig.json { "UserSecretId": "arn:aws:secretsmanager:us-east-2:123456789012:secret:aws/transfer/example-username-key", "TrustedHostKeys": [ "sftp.example.com ssh-rsa AAAAbbbb...EEEE=" ] }
aws transfer create-connector --url "sftp://sftp-server-url" \ --access-role your-IAM-role-for-bucket-access \ --logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \ --sftp-config file://path/to/testSFTPConfig.json
Exemple
L'APIappel renvoie l'ID du nouveau connecteur.
Exemple de réponse
{
"ConnectorId": "a-11112222333344444"
}consultez aussi
Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :
