Syntaxe de la requête Paramètres de demande Syntaxe de la réponse Eléments de réponse Erreurs Exemples consultez aussi

CreateConnector

Crée le connecteur, qui capture les paramètres d'une connexion pour le protocole AS2 ou SFTP. Pour AS2, le connecteur est requis pour envoyer des fichiers à un serveur AS2 hébergé en externe. Pour le SFTP, le connecteur est requis lors de l'envoi de fichiers vers un serveur SFTP ou de la réception de fichiers depuis un serveur SFTP. Pour plus de détails sur les connecteurs, reportez-vous aux sections Configuration des connecteurs AS2 et Création de connecteurs SFTP.

Note

Vous devez spécifier exactement un objet de configuration : soit pour AS2 (As2Config), soit pour 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",
   "SecurityPolicyName": "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.

Cette demande accepte les données suivantes au format JSON.

AccessRole

Les connecteurs sont utilisés pour envoyer des fichiers en utilisant le protocole AS2 ou SFTP. Pour le rôle d'accès, indiquez le nom de ressource Amazon (ARN) du AWS Identity and Access Management rôle à utiliser.

Pour connecteurs AS2

Avec AS2, vous pouvez envoyer des fichiers en appelant StartFileTransfer et en spécifiant les chemins de fichier dans le paramètre de requête, SendFilePaths. Nous utilisons le répertoire parent du fichier (par exemple, pour --send-file-paths /bucket/dir/file.txt, le répertoire parent est /bucket/dir/) pour stocker temporairement un fichier de messages AS2 traité, stocker le MDN lorsque nous les recevons du partenaire et écrire un fichier JSON final contenant les métadonnées pertinentes de la transmission. Ainsi, le AccessRole doit fournir un accès en lecture et en écriture au répertoire parent de l'emplacement du fichier utilisé dans la requête StartFileTransfer. En outre, vous devez fournir un accès en lecture et en écriture au répertoire parent des fichiers que vous souhaitez envoyer avec StartFileTransfer.

Si vous utilisez l'authentification de base pour votre connecteur AS2, 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'une kms:Decrypt autorisation pour cette clé.

Pour connecteurs SFTP

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 StartFileTransfer demande. En outre, assurez-vous que le rôle fournit secretsmanager:GetSecretValue l'autorisation de AWS Secrets Manager.

Type : chaîne

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 du connecteur AS2.

Type : objet As2ConnectorConfig

Obligatoire : non

LoggingRole

Le 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 : chaîne

Contraintes de longueur : longueur minimale de 20. Longueur maximale de 2048.

Modèle : arn:.*role/\S+

Obligatoire : non

SecurityPolicyName

Spécifie le nom de la politique de sécurité pour le connecteur.

Type : chaîne

Contraintes de longueur : longueur minimum de 0. Longueur maximum de 100.

Modèle : TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+

Obligatoire : non

SftpConfig

Structure contenant les paramètres d'un objet de connecteur SFTP.

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

URL du point de terminaison AS2 ou SFTP du partenaire.

Type : chaîne

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 au format JSON par le service.

ConnectorId

Identifiant unique du connecteur, renvoyé une fois l'appel d'API réussi.

Type : chaîne

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.

Code d’état HTTP : 500

InvalidRequestException

Cette exception est levée lorsque le client soumet une demande mal formée.

Code d’état HTTP : 400

ResourceExistsException

La ressource demandée n'existe pas ou existe dans une région autre que celle spécifiée pour la commande.

Code d’état HTTP : 400

ResourceNotFoundException

Cette exception est levée lorsqu'aucune ressource n'est trouvée par le service AWS Transfer Family.

Code d’état HTTP : 400

ServiceUnavailableException

La demande a échoué car le service AWS Transfer Family n'est pas disponible.

Code d’état HTTP : 500

ThrottlingException

La demande a été refusée suite à une limitation des demandes.

Code d’état HTTP : 400

Exemples

Exemple

L'exemple suivant crée un connecteur AS2. Dans la commande, remplacez les éléments comme suit :

url: fournissez l'URL du serveur AS2 du partenaire commercial.
your-IAM-role-for-bucket-access: un rôle IAM qui a accès au compartiment Amazon S3 que vous utilisez pour stocker vos fichiers.
Utilisez l'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 connecteur AS2. L'objet de configuration du connecteur AS2 est décrit dans ConnectorConfigAs2.


// 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 connecteur SFTP. Dans la commande, remplacez les éléments comme suit :

sftp-server-url: indiquez l'URL du serveur SFTP avec lequel vous échangez des fichiers.
your-IAM-role-for-bucket-access: un rôle IAM qui a accès au compartiment Amazon S3 que vous utilisez pour stocker vos fichiers.
Utilisez l'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 connecteur SFTP. L'objet de configuration du connecteur SFTP 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'appel d'API renvoie l'ID du nouveau connecteur.

Exemple de réponse


{
    "ConnectorId": "a-11112222333344444"
}

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

CreateAgreement

CreateProfile