CreateProfile - 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.

CreateProfile

Erstellt das lokale Profil oder Partnerprofil, das für AS2-Übertragungen verwendet werden soll.

Anforderungssyntax

{
   "As2Id": "string",
   "CertificateIds": [ "string" ],
   "ProfileType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Anforderungsparameter

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

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

As2Id

Die As2Id ist der AS2-Name, wie in RFC 4130 definiert. Bei eingehenden Übertragungen ist dies der AS2-From-Header für die vom Partner gesendeten AS2-Nachrichten. Bei ausgehenden Connectors ist dies der AS2-To-Header für die AS2-Nachrichten, die mithilfe der StartFileTransfer-API-Operation an den Partner gesendet werden. Diese ID darf keine Leerzeichen enthalten.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.

Pattern: [\p{Print}\s]*

Erforderlich: Ja

CertificateIds

Ein Array von Kennungen für die importierten Zertifikate. Sie verwenden diese Kennung für die Arbeit mit Profilen und Partnerprofilen.

Typ: Zeichenfolgen-Array

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

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

Erforderlich: Nein

ProfileType

Bestimmt den Typ des zu erstellenden Profils:

  • Geben Sie LOCAL an, ob ein lokales Profil erstellt werden soll. Ein lokales Profil stellt die AS2-fähige Transfer Family Family-Serverorganisation oder -partei dar.

  • Geben Sie PARTNER an, ob Sie ein Partnerprofil erstellen möchten. Ein Partnerprofil steht für eine Remote-Organisation außerhalb von Transfer Family.

Typ: Zeichenfolge

Zulässige Werte: LOCAL | PARTNER

Erforderlich: Ja

Tags

Schlüssel-Wert-Paare, die zur Gruppierung und Suche nach AS2-Profilen 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

{
   "ProfileId": "string"
}

Antwortelemente

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

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

ProfileId

Die eindeutige Kennung für das AS2-Profil, die nach erfolgreichem API-Aufruf zurückgegeben wird.

Typ: Zeichenfolge

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

Pattern: p-([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.

HTTP Status Code: 500

InvalidRequestException

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

HTTP Status Code: 400

ResourceNotFoundException

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

HTTP Status Code: 400

ServiceUnavailableException

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

HTTP Status Code: 500

ThrottlingException

Die Anforderung wurde aufgrund der Drosselung von Anforderungen abgelehnt.

HTTP Status Code: 400

Beispiele

Beispiel

Im folgenden Beispiel wird ein Profil erstellt und die Profil-ID zurückgegeben.

Die Zertifikat-IDs werden bei der Ausführung erstelltimport-certificate, eine für das Signaturzertifikat und eine für das Verschlüsselungszertifikat.

aws transfer create-profile --as2-id MYCORP --certificate-ids c-abcdefg123456hijk
               c-987654aaaa321bbbb

Beispielantwort

Der API-Aufruf gibt die Profil-ID für das neue Profil zurück.

{
    "ProfileId": "p-11112222333344444"
}

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: