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.
UpdateAgreement
Met à jour certains paramètres d'un accord existant. Indiquez le AgreementId et le ServerId pour l'accord que vous souhaitez mettre à jour, ainsi que les nouvelles valeurs des paramètres à mettre à jour.
Syntaxe de la requête
{
"AccessRole": "string",
"AgreementId": "string",
"BaseDirectory": "string",
"Description": "string",
"LocalProfileId": "string",
"PartnerProfileId": "string",
"ServerId": "string",
"Status": "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. En outre, assurez-vous que le rôle fournitsecretsmanager:GetSecretValuel'autorisation de AWS Secrets Manager.Type : String
Contraintes de longueur : longueur minimale de 20. Longueur maximale de 2048.
Modèle :
arn:.*role/\S+Obligatoire : non
- AgreementId
-
Identifiant unique pour l'accord. Cet identifiant est renvoyé lorsque vous créez un accord.
Type : String
Contraintes de longueur : longueur fixe de 19.
Modèle :
a-([0-9a-f]{17})Obligatoire : oui
- BaseDirectory
-
Pour modifier le répertoire de destination (dossier) des fichiers transférés, indiquez le dossier de compartiment que vous souhaitez utiliser, par exemple,
/DOC-EXAMPLE-BUCKET/home/mydirectory.Type : String
Contraintes de longueur : longueur minimum de 0. Longueur maximum de 1024.
Modèle :
(|/.*)Obligatoire : non
- Description
-
Pour remplacer la description existante, fournissez une brève description de 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.
Pour modifier l'identifiant de profil local, entrez une nouvelle valeur ici.
Type : String
Contraintes de longueur : longueur fixe de 19.
Modèle :
p-([0-9a-f]{17})Obligatoire : non
- PartnerProfileId
-
Identifiant unique pour le profil du partenaire. Pour modifier l'identifiant du profil du partenaire, entrez une nouvelle valeur ici.
Type : String
Contraintes de longueur : longueur fixe de 19.
Modèle :
p-([0-9a-f]{17})Obligatoire : non
- 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
-
Vous pouvez mettre à jour le statut de l'accord, soit en activant un accord inactif, soit en inversant.
Type : String
Valeurs valides :
ACTIVE | INACTIVEObligatoire : 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
-
Identifiant unique pour l'accord. Cet identifiant est renvoyé lorsque vous créez un 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
consultez aussi
Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :
