UpdateConnector

Aktualisiert einige Parameter für einen vorhandenen Konnektor. Geben Sie die Werte ConnectorId für den Connector an, den Sie aktualisieren möchten, zusammen mit den neuen Werten für die zu aktualisierenden Parameter.

Anforderungssyntax

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

AccessRole

Konnektoren werden verwendet, um Dateien entweder über das AS2- oder das SFTP-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 AS2 senden Sie Dateien, indem Sie StartFileTransfer aufrufen und die Dateipfade im Anforderungsparameter SendFilePaths angeben. Mit dem übergeordneten Verzeichnis der Datei (Beispiel: das übergeordnetes Verzeichnis für --send-file-paths /bucket/dir/file.txt ist /bucket/dir/) speichern wir eine verarbeitete AS2-Nachrichtendatei vorübergehend, speichern die MDN, wenn wir sie vom Partner erhalten, und schreiben eine endgültige JSON-Datei, die relevante 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, erfordert die Zugriffsrolle die secretsmanager:GetSecretValue Erlaubnis für den geheimen Schlüssel. 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 SFTP-Konnektoren

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

As2Config

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

Typ: As2ConnectorConfig Objekt

Erforderlich: Nein

ConnectorId

Der eindeutige Bezeichner für den Konnektor.

Typ: Zeichenfolge

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

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

Erforderlich: Ja

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

SecurityPolicyName

Gibt den Namen der Sicherheitsrichtlinie für den Connector an.

Typ: Zeichenfolge

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

Pattern: TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+

Erforderlich: Nein

SftpConfig

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

Typ: SftpConnectorConfig Objekt

Erforderlich: Nein

Url

Die URL des AS2- oder SFTP-Endpunkts des Partners.

Typ: Zeichenfolge

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

Erforderlich: Nein

Antwortsyntax

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

ConnectorId

Gibt den Bezeichner des Connector-Objekts zurück, das Sie aktualisieren.

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.

HTTP Status Code: 500

InvalidRequestException

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

HTTP Status Code: 400

ResourceExistsException

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

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

Weitere Informationen finden Sie unter:

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

• AWS -Befehlszeilenschnittstelle

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK für JavaScript V3

• AWS SDK for PHP V3

• AWS SDK für Python

• AWS SDK for Ruby V3