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 das 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 Anfrage akzeptiert die folgenden Daten im JSON Format.
- As2Id
-
Das
As2Idist der AS2-name, wie er im RFC4130definiert ist. Bei eingehenden Übertragungen ist dies der AS2-FromHeader für die vom Partner gesendeten AS2 Nachrichten. Bei ausgehenden Connectors ist dies derAS2-ToHeader für die AS2 Nachrichten, die mithilfe der Operation an den Partner gesendet wurden.StartFileTransferAPI 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
LOCALan, ob ein lokales Profil erstellt werden soll. Ein lokales Profil steht für die Transfer Family Family-Serverorganisation oder AS2 -partei, die -aktiviert ist. -
Geben Sie
PARTNERan, 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 | PARTNERErforderlich: Ja
-
- Tags
-
Schlüssel-Wert-Paare, die zum Gruppieren und Suchen AS2 nach 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 Dienst eine HTTP 200-Antwort zurück.
Die folgenden Daten werden vom Dienst 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.
HTTPStatuscode: 500
- InvalidRequestException
-
Diese Ausnahme wird ausgelöst, wenn der Client eine falsch formatierte Anfrage sendet.
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 ein Profil erstellt und die Profil-ID zurückgegeben.
Die Zertifikate IDs werden bei der Ausführung erstelltimport-certificate, eines für das Signaturzertifikat und eines 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 API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
