DescribedAgreement - AWS Transfer Family

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

DescribedAgreement

Beschreibt die Eigenschaften einer Vereinbarung.

Inhalt

Arn

Der eindeutige Amazon-Ressourcenname (ARN) für die Vereinbarung.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.

Pattern: arn:\S+

Erforderlich: Ja

AccessRole

Konnektoren werden verwendet, um Dateien entweder mit dem AS2 SFTP OR-Protokoll zu senden. Geben Sie für die Zugriffsrolle den Amazon-Ressourcennamen (ARN) der zu AWS Identity and Access Management verwendenden Rolle an.

Für AS2 Konnektoren

Mit können Sie Dateien sendenAS2, indem Sie die Dateipfade aufrufen StartFileTransfer und im Anforderungsparameter angebenSendFilePaths. Wir verwenden das übergeordnete Verzeichnis der Datei (z. B. for--send-file-paths /bucket/dir/file.txt, übergeordnetes Verzeichnis ist/bucket/dir/), um eine verarbeitete AS2 Nachrichtendatei vorübergehend zu speichern, zu speichern, MDN wann wir sie vom Partner erhalten, und eine endgültige JSON Datei zu schreiben, die die relevanten Metadaten der Übertragung enthält. Daher muss AccessRole Lese- und Schreibzugriff auf das übergeordnete Verzeichnis des in der StartFileTransfer-Anforderung verwendeten Dateispeicherorts gewähren. Darüber hinaus müssen Sie Lese- und Schreibzugriff für das übergeordnete Verzeichnis der Dateien gewähren, die Sie mit StartFileTransfer senden möchten.

Wenn Sie die Standardauthentifizierung für Ihren AS2 Connector verwenden, benötigt die Zugriffsrolle die secretsmanager:GetSecretValue Erlaubnis für das Geheimnis. Wenn das Geheimnis mit einem vom Kunden verwalteten Schlüssel anstelle des AWS verwalteten Schlüssels in Secrets Manager verschlüsselt wird, benötigt die Rolle auch die kms:Decrypt Erlaubnis für diesen Schlüssel.

Für Konnektoren SFTP

Stellen Sie sicher, dass die Zugriffsrolle Lese- und Schreibzugriff auf das übergeordnete Verzeichnis des Dateispeicherorts bietet, der in der StartFileTransfer Anfrage verwendet wird. Stellen Sie außerdem sicher, dass die Rolle die secretsmanager:GetSecretValue Berechtigung dazu bietet AWS Secrets Manager.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 2048 Zeichen.

Pattern: arn:.*role/\S+

Erforderlich: Nein

AgreementId

Eine eindeutige Kennung für die Vereinbarung. Diese Kennung wird zurückgegeben, wenn Sie eine Vereinbarung erstellen.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

Pattern: a-([0-9a-f]{17})

Erforderlich: Nein

BaseDirectory

Das Zielverzeichnis (Ordner) für Dateien, die mithilfe des AS2 Protokolls übertragen werden.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.

Pattern: (|/.*)

Erforderlich: Nein

Description

Der Name oder die kurze Beschreibung, der/die zur Identifizierung der Vereinbarung verwendet wird.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 1. Höchstlänge = 200 Zeichen.

Pattern: [\p{Graph}]+

Erforderlich: Nein

LocalProfileId

Ein eindeutiger Bezeichner für das AS2 lokale Profil.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

Pattern: p-([0-9a-f]{17})

Erforderlich: Nein

PartnerProfileId

Eine eindeutige Kennung für das in der Vereinbarung verwendete Partnerprofil.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

Pattern: p-([0-9a-f]{17})

Erforderlich: Nein

ServerId

Eine vom System zugewiesene eindeutige ID für eine Server-Instance. Diese Kennung gibt den spezifischen Server an, den die Vereinbarung verwendet.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

Pattern: s-([0-9a-f]{17})

Erforderlich: Nein

Status

Der aktuelle Status der Vereinbarung, entweder ACTIVE oder INACTIVE.

Typ: Zeichenfolge

Zulässige Werte: ACTIVE | INACTIVE

Erforderlich: Nein

Tags

Schlüssel-Wert-Paare, die zur Gruppierung und Suche von Vereinbarungen verwendet werden können.

Typ: Array von Tag-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 50 Elemente.

Erforderlich: Nein

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: