CreateProfile - AWS Transfer Family
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursExemplesconsultez aussi

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.

CreateProfile

Crée le profil local ou partenaire à utiliser pour les transferts AS2.

Syntaxe de la requête

{
   "As2Id": "string",
   "CertificateIds": [ "string" ],
   "ProfileType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

As2Id

L'As2Id est l'AS2-name, tel que défini dans la RFC 4130. Pour les transferts entrants, il s'agit de l'en-tête AS2-From des messages AS2 envoyés par le partenaire. Pour les connecteurs sortants, il s'agit de l'en-tête AS2-To des messages AS2 envoyés au partenaire à l'aide de l'opération d'API StartFileTransfer. Cet identifiant ne peut pas inclure d'espaces.

Type : chaîne

Contraintes de longueur : Longueur minimum de 1. Longueur maximale de 128.

Modèle : [\p{Print}\s]*

Obligatoire : oui

CertificateIds

Un tableau d'identifiants pour les certificats importés. Vous utilisez cet identifiant pour travailler avec des profils et des profils de partenaires.

Type : tableau de chaînes

Contraintes de longueur : longueur fixe de 22.

Modèle : cert-([0-9a-f]{17})

Obligatoire : non

ProfileType

Détermine le type de profil à créer :

  • Spécifiez LOCAL pour créer un profil local. Un profil local représente l'organisation ou le groupe de serveurs Transfer Family compatible AS2.

  • Spécifiez PARTNER pour créer un profil de partenaire. Un profil de partenaire représente une organisation distante, externe à Transfer Family.

Type : chaîne

Valeurs valides : LOCAL | PARTNER

Obligatoire : oui

Tags

Paires clé-valeur qui peuvent être utilisées pour regrouper et rechercher des profils AS2.

Type : tableau d’objets Tag

Membres du tableau : Nombre minimum de 1 élément. Nombre maximal de 50 éléments.

Obligatoire : non

Syntaxe de la réponse

{
   "ProfileId": "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.

ProfileId

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

Type : chaîne

Contraintes de longueur : longueur fixe de 19.

Modèle : p-([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

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 profil et renvoie l'ID du profil.

Les identifiants de certificat sont créés lors de l'exécutionimport-certificate, un pour le certificat de signature et un pour le certificat de chiffrement.

aws transfer create-profile --as2-id MYCORP --certificate-ids c-abcdefg123456hijk
               c-987654aaaa321bbbb

Exemple de réponse

L'appel d'API renvoie l'ID de profil du nouveau profil.

{
    "ProfileId": "p-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 :