CreateAgreement - AWS Transfer Family
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerBeispieleWeitere Informationen finden Sie unter:

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.

CreateAgreement

Erstellt eine Vereinbarung. Eine Vereinbarung ist eine bilaterale Handelspartnervereinbarung oder Partnerschaft zwischen einem AWS Transfer Family Server und einem AS2 Prozess. Die Vereinbarung definiert die Datei- und Nachrichtenübertragungsbeziehung zwischen dem Server und dem AS2 Prozess. Zum Definieren einer Vereinbarung kombiniert Transfer Family einen Server, ein lokales Profil, ein Partnerprofil, ein Zertifikat und andere Attribute.

Der Partner wird mit dem identifiziertPartnerProfileId, und der AS2 Prozess wird mit dem identifiziertLocalProfileId.

Anforderungssyntax

{
   "AccessRole": "string",
   "BaseDirectory": "string",
   "Description": "string",
   "LocalProfileId": "string",
   "PartnerProfileId": "string",
   "ServerId": "string",
   "Status": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.

Die Anfrage akzeptiert die folgenden Daten im JSON Format.

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

BaseDirectory

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

Ein Beispiel für BaseDirectory ist /DOC-EXAMPLE-BUCKET/home/mydirectory.

Typ: Zeichenfolge

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

Pattern: (|/.*)

Erforderlich: Ja

Description

Ein Name oder eine kurze Beschreibung zur Identifizierung der Vereinbarung.

Typ: Zeichenfolge

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

Pattern: [\p{Graph}]+

Erforderlich: Nein

LocalProfileId

Eine eindeutige Kennung für das AS2 lokale Profil.

Typ: Zeichenfolge

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

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

Erforderlich: Ja

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

ServerId

Eine vom System zugewiesene eindeutige ID für eine Server-Instance. Dies ist der spezifische Server, den die Vereinbarung verwendet.

Typ: Zeichenfolge

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

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

Erforderlich: Ja

Status

Der Status der Vereinbarung. Die Vereinbarung kann entweder ACTIVE oder seinINACTIVE.

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

Antwortsyntax

{
   "AgreementId": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Dienst eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Dienst im JSON Format zurückgegeben.

AgreementId

Die eindeutige Kennung für die Vereinbarung. Verwenden Sie diese ID zum Löschen oder Aktualisieren einer Vereinbarung sowie für alle anderen API Anrufe, bei denen Sie die Vereinbarungs-ID angeben müssen.

Typ: Zeichenfolge

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

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

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

InternalServiceError

Diese Ausnahme wird ausgelöst, wenn im AWS Transfer Family Dienst ein Fehler auftritt.

HTTPStatuscode: 500

InvalidRequestException

Diese Ausnahme wird ausgelöst, wenn der Client eine falsch formatierte Anfrage sendet.

HTTPStatuscode: 400

ResourceExistsException

Die angeforderte Ressource ist nicht vorhanden oder befindet sich in einer anderen Region als der für den Befehl angegebenen.

HTTPStatuscode: 400

ResourceNotFoundException

Diese Ausnahme wird ausgelöst, wenn eine Ressource vom AWS Transfer Family Family-Dienst nicht gefunden wird.

HTTPStatuscode: 400

ServiceUnavailableException

Die Anfrage ist fehlgeschlagen, da der AWS Transfer Family Family-Dienst nicht verfügbar ist.

HTTPStatuscode: 500

ThrottlingException

Die Anforderung wurde aufgrund der Drosselung von Anforderungen abgelehnt.

HTTPStatuscode: 400

Beispiele

Beispiel

Im folgenden Beispiel wird eine Vereinbarung erstellt und die Vereinbarungs-ID zurückgegeben.

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

Beispielantwort

Der API Aufruf gibt die Vereinbarungs-ID für die neue Vereinbarung zurück.

{
    "AgreementId": "a-11112222333344444"
}

Weitere Informationen finden Sie unter:

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