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.
CreateAgreement
Crée un accord. Un accord est un accord de partenariat commercial bilatéral, ou partenariat, entre un AWS Transfer Family serveur et un AS2 processus. L'accord définit la relation de transfert de fichiers et de messages entre le serveur et le AS2 processus. Pour définir un accord, Transfer Family combine un serveur, un profil local, un profil de partenaire, un certificat et d'autres attributs.
Le partenaire est identifié par lePartnerProfileId, et le AS2 processus est identifié par leLocalProfileId.
Syntaxe de la requête
{
"AccessRole": "string",
"BaseDirectory": "string",
"Description": "string",
"LocalProfileId": "string",
"PartnerProfileId": "string",
"ServerId": "string",
"Status": "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.
La demande accepte le JSON format des données suivantes.
- 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
- BaseDirectory
-
Le répertoire de destination (dossier) pour les fichiers transférés à l'aide du AS2 protocole.
Un exemple de
BaseDirectoryest/DOC-EXAMPLE-BUCKET/home/mydirectory.Type : String
Contraintes de longueur : longueur minimum de 0. Longueur maximum de 1024.
Modèle :
(|/.*)Obligatoire : oui
- Description
-
Un nom ou une brève description pour identifier l'accord.
Type : String
Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 200.
Modèle :
[\p{Graph}]+Obligatoire : non
- LocalProfileId
-
Identifiant unique pour le profil AS2 local.
Type : String
Contraintes de longueur : longueur fixe de 19.
Modèle :
p-([0-9a-f]{17})Obligatoire : oui
- PartnerProfileId
-
Un identifiant unique pour le profil de partenaire utilisé dans l'accord.
Type : String
Contraintes de longueur : longueur fixe de 19.
Modèle :
p-([0-9a-f]{17})Obligatoire : oui
- ServerId
-
Identifiant unique attribué par le système pour une instance de serveur. Il s'agit du serveur spécifique utilisé par le contrat.
Type : String
Contraintes de longueur : longueur fixe de 19.
Modèle :
s-([0-9a-f]{17})Obligatoire : oui
- Status
-
État de l'accord. L'accord peut être l'un
ACTIVEou l'autreINACTIVE.Type : String
Valeurs valides :
ACTIVE | INACTIVEObligatoire : non
- Tags
-
Paires clé-valeur qui peuvent être utilisées pour regrouper et rechercher des accords.
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
{
"AgreementId": "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.
- AgreementId
-
L'identifiant unique de l'accord. Utilisez cet identifiant pour supprimer ou mettre à jour un accord, ainsi que pour tout autre API appel nécessitant que vous spécifiiez l'identifiant de l'accord.
Type : String
Contraintes de longueur : longueur fixe de 19.
Modèle :
a-([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 accord et renvoie l'ID de l'accord.
aws transfer create-agreement --server-id s-021345abcdef6789 --local-profile-id p-1234567890abcdef0 --partner-profile-id p-abcdef01234567890 --base-folder /DOC-EXAMPLE-BUCKET/AS2-files --access-role arn:aws:iam::111122223333:role/AS2-role
Exemple de réponse
L'APIappel renvoie l'identifiant de l'accord pour le nouvel accord.
{ "AgreementId": "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 :
