DescribedAgreement - AWS Transfer Family

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.

DescribedAgreement

Décrit les propriétés d'un accord.

Table des matières

Arn

Le nom unique de la ressource Amazon (ARN) pour le contrat.

Type : String

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

Modèle : arn:\S+

Obligatoire : oui

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 StartFileTransfer et 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, 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 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'une kms:Decrypt autorisation 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 StartFileTransfer demande. En outre, assurez-vous que le rôle fournit secretsmanager:GetSecretValue l'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 : non

BaseDirectory

Le répertoire de destination (dossier) pour les fichiers transférés à l'aide du AS2 protocole.

Type : String

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

Modèle : (|/.*)

Obligatoire : non

Description

Le nom ou la brève description qui est utilisé 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 : non

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 : non

ServerId

Identifiant unique attribué par le système pour une instance de serveur. Cet identifiant indique le serveur spécifique utilisé par l'accord.

Type : String

Contraintes de longueur : longueur fixe de 19.

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

Obligatoire : non

Status

L'état actuel de l'accord, soit ACTIVE ou INACTIVE.

Type : String

Valeurs valides : ACTIVE | INACTIVE

Obligatoire : 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

consultez aussi

Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :