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

CreateConnector

Erzeugt den Konnektor, der die Parameter für eine Verbindung für das AS2 SFTP OR-Protokoll erfasst. Denn der Connector ist erforderlichAS2, um Dateien an einen extern gehosteten AS2 Server zu senden. Denn der Connector ist erforderlichSFTP, wenn Dateien an einen SFTP Server gesendet oder Dateien von einem SFTP Server empfangen werden. Weitere Informationen zu Konnektoren finden Sie unter AS2 Konnektoren konfigurieren und SFTPKonnektoren erstellen.

Anmerkung

Sie müssen genau ein Konfigurationsobjekt angeben: entweder für AS2 (As2Config) oder SFTP (SftpConfig).

Anforderungssyntax

{
   "AccessRole": "string",
   "As2Config": { 
      "BasicAuthSecretId": "string",
      "Compression": "string",
      "EncryptionAlgorithm": "string",
      "LocalProfileId": "string",
      "MdnResponse": "string",
      "MdnSigningAlgorithm": "string",
      "MessageSubject": "string",
      "PartnerProfileId": "string",
      "SigningAlgorithm": "string"
   },
   "LoggingRole": "string",
   "SftpConfig": { 
      "TrustedHostKeys": [ "string" ],
      "UserSecretId": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Url": "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 Steckverbinder

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

As2Config

Eine Struktur, die die Parameter für ein AS2 Connector-Objekt enthält.

Typ: As2ConnectorConfig Objekt

Erforderlich: Nein

LoggingRole

Der Amazon-Ressourcenname (ARN) der Rolle AWS Identity and Access Management (IAM), der es einem Connector ermöglicht, die CloudWatch Protokollierung für Amazon S3-Ereignisse zu aktivieren. Wenn diese Option aktiviert ist, können Sie die Connector-Aktivität in Ihren CloudWatch Protokollen einsehen.

Typ: Zeichenfolge

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

Pattern: arn:.*role/\S+

Erforderlich: Nein

SftpConfig

Eine Struktur, die die Parameter für ein SFTP Connector-Objekt enthält.

Typ: SftpConnectorConfig Objekt

Erforderlich: Nein

Tags

Schlüssel-Wert-Paare, die zur Gruppierung und Suche von Connectors verwendet werden. Tags sind Metadaten, die für jeden Zweck an Konnektoren angehängt werden.

Typ: Array von Tag-Objekten

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

Erforderlich: Nein

Url

Der URL des Partners AS2 oder SFTP Endpunkts.

Typ: Zeichenfolge

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

Erforderlich: Ja

Antwortsyntax

{
   "ConnectorId": "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.

ConnectorId

Die eindeutige Kennung für den Connector, die nach erfolgreichem API Aufruf zurückgegeben wird.

Typ: Zeichenfolge

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

Pattern: c-([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 ein AS2 Konnektor erstellt. Ersetzen Sie im Befehl die Elemente wie folgt:

  • url: Geben Sie den URL für den AS2 Server des Handelspartners an.

  • your-IAM-role-for-bucket-access: eine IAM Rolle, die Zugriff auf den Amazon S3 S3-Bucket hat, den Sie zum Speichern Ihrer Dateien verwenden.

  • Verwenden Sie die Rolle ARN für Ihre Protokollierung, die Ihre AWS-Konto ID enthält.

  • Geben Sie einen Pfad zu einer Datei an, die die AS2 Konnektor-Konfigurationsparameter enthält. Das AS2 Connector-Konfigurationsobjekt wird in As2 ConnectorConfig beschrieben.

// Listing for testAs2Config.json
{
  "LocalProfileId": "your-profile-id",
  "PartnerProfileId": "partner-profile-id",
  "MdnResponse": "SYNC",
  "Compression": "ZLIB",
  "EncryptionAlgorithm": "AES256_CBC",
  "SigningAlgorithm": "SHA256",
  "MdnSigningAlgorithm": "DEFAULT",
  "MessageSubject": "Your Message Subject"
}
        
aws transfer create-connector --url "http://partner-as2-server-url" \
          --access-role your-IAM-role-for-bucket-access \
          --logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \
          --as2-config file://path/to/testAS2Config.json

Beispiel

Das folgende Beispiel erstellt einen SFTP Konnektor. Ersetzen Sie im Befehl die Elemente wie folgt:

  • sftp-server-url: Geben Sie die URL für den SFTP Server an, mit dem Sie Dateien austauschen.

  • your-IAM-role-for-bucket-access: eine IAM Rolle, die Zugriff auf den Amazon S3 S3-Bucket hat, den Sie zum Speichern Ihrer Dateien verwenden.

  • Verwenden Sie die Rolle ARN für Ihre Protokollierung, die Ihre AWS-Konto ID enthält.

  • Geben Sie einen Pfad zu einer Datei an, die die SFTP Konnektor-Konfigurationsparameter enthält. Das SFTP Connector-Konfigurationsobjekt wird unter beschrieben SftpConnectorConfig.

// Listing for testSFTPConfig.json
{   
   "UserSecretId": "arn:aws:secretsmanager:us-east-2:123456789012:secret:aws/transfer/example-username-key",
   "TrustedHostKeys": [
      "sftp.example.com ssh-rsa AAAAbbbb...EEEE="
   ]
}
aws transfer create-connector --url "sftp://sftp-server-url" \
--access-role your-IAM-role-for-bucket-access \
--logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \
--sftp-config file://path/to/testSFTPConfig.json

Beispiel

Der API Aufruf gibt die Connector-ID für den neuen Connector zurück.

Beispielantwort

{
    "ConnectorId": "a-11112222333344444"
}

Weitere Informationen finden Sie unter:

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