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.
UpdateServer
Aktualisiert die Eigenschaften des Servers, für den das Dateiübertragungsprotokoll aktiviert ist, nachdem dieser Server erstellt wurde.
Der UpdateServer
Aufruf gibt den des Servers zurück, ServerId
den Sie aktualisiert haben.
Anforderungssyntax
{
"Certificate": "string
",
"EndpointDetails": {
"AddressAllocationIds": [ "string
" ],
"SecurityGroupIds": [ "string
" ],
"SubnetIds": [ "string
" ],
"VpcEndpointId": "string
",
"VpcId": "string
"
},
"EndpointType": "string
",
"HostKey": "string
",
"IdentityProviderDetails": {
"DirectoryId": "string
",
"Function": "string
",
"InvocationRole": "string
",
"SftpAuthenticationMethods": "string
",
"Url": "string
"
},
"LoggingRole": "string
",
"PostAuthenticationLoginBanner": "string
",
"PreAuthenticationLoginBanner": "string
",
"ProtocolDetails": {
"As2Transports": [ "string
" ],
"PassiveIp": "string
",
"SetStatOption": "string
",
"TlsSessionResumptionMode": "string
"
},
"Protocols": [ "string
" ],
"S3StorageOptions": {
"DirectoryListingOptimization": "string
"
},
"SecurityPolicyName": "string
",
"ServerId": "string
",
"StructuredLogDestinations": [ "string
" ],
"WorkflowDetails": {
"OnPartialUpload": [
{
"ExecutionRole": "string
",
"WorkflowId": "string
"
}
],
"OnUpload": [
{
"ExecutionRole": "string
",
"WorkflowId": "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.
- Certificate
-
Der Amazon-Ressourcenname (ARN) des AWS Certificate Manager (ACM) -Zertifikats. Erforderlich, wenn
Protocols
aufFTPS
eingestellt ist.Informationen zum Anfordern eines neuen öffentlichen Zertifikats finden Sie unter Anfordern eines öffentlichen Zertifikats im AWS Certificate Manager Manager-Benutzerhandbuch.
Informationen zum Importieren eines vorhandenen Zertifikats finden Sie unter Zertifikate importieren in ACM im AWS Certificate Manager Manager-Benutzerhandbuch. ACM
Informationen zum Anfordern eines privaten Zertifikats zur Verwendung FTPS über private IP-Adressen finden Sie unter Anfordern eines privaten Zertifikats im AWS Certificate Manager Manager-Benutzerhandbuch.
Zertifikate mit den folgenden kryptografischen Algorithmen und Schlüsselgrößen werden unterstützt:
-
2048-Bit RSA (_2048) RSA
-
4096-Bit (_4096) RSA RSA
-
Elliptic Prime Curve 256-Bit (EC_prime256v1)
-
Elliptic Prime Curve 384-Bit (EC_secp384r1)
-
Elliptic Prime Curve 521-Bit (EC_secp521r1)
Anmerkung
Bei dem Zertifikat muss es sich um ein gültigesSSL//TLSX.509 Version 3-Zertifikat mit einer angegebenen IP-Adresse und FQDN Informationen über den Aussteller handeln.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1600 Zeichen.
Erforderlich: Nein
-
- EndpointDetails
-
Die Virtual Private Cloud (VPC) -Endpunkteinstellungen, die für Ihren Server konfiguriert sind. Wenn Sie Ihren Endpunkt in Ihrem hostenVPC, können Sie Ihren Endpunkt nur für Ressourcen innerhalb Ihres Computers zugänglich machenVPC, oder Sie können Elastic IP-Adressen anhängen und Ihren Endpunkt für Clients über das Internet zugänglich machen. Ihre VPC Standard-Sicherheitsgruppen werden Ihrem Endpunkt automatisch zugewiesen.
Typ: EndpointDetails Objekt
Erforderlich: Nein
- EndpointType
-
Der Typ des Endpunkts, den Ihr Server verwenden soll. Sie können wählen, ob Sie den Endpunkt Ihres Servers öffentlich zugänglich machen (PUBLIC) oder ihn auf Ihrem Server hosten möchtenVPC. Bei einem Endpunkt, der in einem gehostet wirdVPC, können Sie den Zugriff auf Ihren Server und Ihre Ressourcen auf Ihren Server und Ihre Ressourcen beschränken VPC oder ihn mit dem Internet verbinden, indem Sie Elastic IP-Adressen direkt an ihn anhängen.
Anmerkung
Nach dem 19. Mai 2021 können Sie mit
EndpointType=VPC_ENDPOINT
Ihrem Konto keinen Server mehr erstellen, sofern Ihr AWS Konto dies nicht bereits vor dem 19. Mai 2021 getan hat. Wenn du am oder vor dem 19. Mai 2021 bereits Server mitEndpointType=VPC_ENDPOINT
deinem AWS Konto erstellt hast, bist du davon nicht betroffen. Verwenden Sie nach diesem DatumEndpointType
=VPC
.Weitere Informationen finden Sie unter Einstellung der Verwendung von _ VPC ENDPOINT.
Es wird empfohlen, dass Sie
VPC
alsEndpointType
verwenden. Bei diesem Endpunkttyp haben Sie die Möglichkeit, bis zu drei IPv4 Elastic-Adressen (einschließlich BYO IP) direkt mit dem Endpunkt Ihres Servers zu verknüpfen und mithilfe von VPC Sicherheitsgruppen den Datenverkehr anhand der öffentlichen IP-Adresse des Clients einzuschränken. Dies ist nicht möglich, wennEndpointType
aufVPC_ENDPOINT
gesetzt ist.Typ: Zeichenfolge
Zulässige Werte:
PUBLIC | VPC | VPC_ENDPOINT
Erforderlich: Nein
- HostKey
-
Der RSAECDSA, oder ED25519 private Schlüssel, der für Ihren SFTP -fähigen Server verwendet werden soll. Sie können mehrere Hostschlüssel hinzufügen, falls Sie Schlüssel rotieren möchten oder wenn Sie über einen Satz aktiver Schlüssel verfügen, die unterschiedliche Algorithmen verwenden.
Verwenden Sie den folgenden Befehl, um einen RSA 2048-Bit-Schlüssel ohne Passphrase zu generieren:
ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key
.Verwenden Sie einen Mindestwert von 2048 für die Option.
-b
Sie können einen stärkeren Schlüssel erstellen, indem Sie 3072 oder 4096 verwenden.Verwenden Sie den folgenden Befehl, um einen ECDSA 256-Bit-Schlüssel ohne Passphrase zu generieren:
ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key
.Gültige Werte für die
-b
Option für ECDSA sind 256, 384 und 521.Verwenden Sie den folgenden Befehl, um einen ED25519 Schlüssel ohne Passphrase zu generieren:
ssh-keygen -t ed25519 -N "" -f my-new-server-key
.Alle diese Befehle können Sie durch eine Zeichenfolge my-new-server-keyIhrer Wahl ersetzen.
Wichtig
Wenn Sie nicht vorhaben, bestehende Benutzer von einem vorhandenen Server mit SFTP aktivierter Option auf einen neuen Server zu migrieren, aktualisieren Sie den Hostschlüssel nicht. Das versehentliche Ändern des Host-Schlüssels eines Servers kann zu Unterbrechungen führen.
Weitere Informationen finden Sie im AWS Transfer Family Benutzerhandbuch unter Hostschlüssel für Ihren SFTP -fähigen Server aktualisieren.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge von 4096.
Erforderlich: Nein
- IdentityProviderDetails
-
Ein Array, das alle Informationen enthält, die zum Aufrufen der API Authentifizierungsmethode eines Kunden erforderlich sind.
Typ: IdentityProviderDetails Objekt
Erforderlich: Nein
- LoggingRole
-
Der Amazon-Ressourcenname (ARN) der Rolle AWS Identity and Access Management (IAM), der es einem Server ermöglicht, die CloudWatch Amazon-Protokollierung für Amazon S3 oder Amazon zu aktivierenEFSevents. Wenn diese Option aktiviert ist, können Sie Benutzeraktivitäten in Ihren CloudWatch Protokollen einsehen.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 2048 Zeichen.
Pattern:
(|arn:.*role/\S+)
Erforderlich: Nein
- PostAuthenticationLoginBanner
-
Gibt eine Zeichenfolge an, die angezeigt wird, wenn Benutzer sich mit einem Server verbinden. Diese Zeichenfolge wird nach Authentifizierung des Benutzers angezeigt.
Anmerkung
Das SFTP Protokoll unterstützt keine Anzeige von Bannern nach der Authentifizierung.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge von 4096.
Pattern:
[\x09-\x0D\x20-\x7E]*
Erforderlich: Nein
- PreAuthenticationLoginBanner
-
Gibt eine Zeichenfolge an, die angezeigt wird, wenn Benutzer sich mit einem Server verbinden. Diese Zeichenfolge wird angezeigt, bevor sich der Benutzer authentifiziert. Das folgende Banner zeigt beispielsweise Details zur Verwendung des Systems an:
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge von 4096.
Pattern:
[\x09-\x0D\x20-\x7E]*
Erforderlich: Nein
- ProtocolDetails
-
Protokolleinstellungen, die für Ihren Server konfiguriert sind.
-
Verwenden Sie den
PassiveIp
Parameter, um den passiven Modus (für FTP und FTPS Protokolle) anzugeben. Geben Sie eine einzelne IPv4 Adresse mit vier Punkten ein, z. B. die externe IP-Adresse einer Firewall, eines Routers oder eines Load Balancers. -
Verwenden Sie den Parameter
SetStatOption
, um den Fehler zu ignorieren, der generiert wird, wenn der Client versucht, den BefehlSETSTAT
für eine Datei zu verwenden, die Sie in einen Amazon-S3-Bucket hochladen. Damit der AWS Transfer Family Server denSETSTAT
Befehl ignoriert und Dateien hochlädt, ohne Änderungen an Ihrem SFTP Client vornehmen zu müssen, setzen Sie den Wert auf.ENABLE_NO_OP
Wenn Sie denSetStatOption
Parameter auf setzenENABLE_NO_OP
, generiert Transfer Family einen Protokolleintrag in Amazon CloudWatch Logs, sodass Sie feststellen können, wann der Client einenSETSTAT
Anruf tätigt. -
Verwenden Sie den
TlsSessionResumptionMode
Parameter, um festzustellen, ob Ihr AWS Transfer Family Server die letzten, ausgehandelten Sitzungen über eine eindeutige Sitzungs-ID wieder aufnimmt. -
As2Transports
gibt die Transportmethode für die AS2 Nachrichten an. Derzeit wird nur HTTP unterstützt.
Typ: ProtocolDetails Objekt
Erforderlich: Nein
-
- Protocols
-
Gibt das/die Dateiübertragungsprotokoll(e) an, über das/die der Dateiübertragungsprotokoll-Client eine Verbindung zum Endpunkt des Servers herstellen kann. Die verfügbaren Protokolle sind:
-
SFTP
(Secure Shell (SSH) File Transfer Protocol): Dateiübertragung über SSH -
FTPS
(File Transfer Protocol Secure): Dateiübertragung mit TLS Verschlüsselung -
FTP
(File Transfer Protocol): Unverschlüsselte Dateiübertragung -
AS2
(Anwendbarkeitserklärung 2): wird für den Transport strukturierter business-to-business Daten verwendet
Anmerkung
-
Wenn Sie auswählen
FTPS
, müssen Sie ein in AWS Certificate Manager (ACM) gespeichertes Zertifikat auswählen, das zur Identifizierung Ihres Servers verwendet wird, wenn Clients eine Verbindung zu ihm herstellen. FTPS -
Wenn
Protocol
entwederFTP
oderFTPS
enthält, mussEndpointType
VPC
lauten undIdentityProviderType
mussAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
oderAPI_GATEWAY
lauten. -
Wenn
Protocol
FTP
enthält, könnenAddressAllocationIds
nicht zugeordnet werden. -
Wenn
Protocol
nur aufSFTP
gesetzt ist, kannEndpointType
aufPUBLIC
gesetzt werden undIdentityProviderType
kann auf einen der unterstützten Identitätstypen gesetzt werden:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
oderAPI_GATEWAY
. -
Wenn das
Protocol
AS2
enthält, dann muss derEndpointType
VPC
lauten und die Domain muss Amazon S3 sein.
Typ: Zeichenfolgen-Array
Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Maximale Anzahl von 4 Elementen.
Zulässige Werte:
SFTP | FTP | FTPS | AS2
Erforderlich: Nein
-
- S3StorageOptions
-
Gibt an, ob die Leistung für Ihre Amazon S3 S3-Verzeichnisse optimiert ist oder nicht. Diese ist standardmäßig deaktiviert.
Standardmäßig haben Zuordnungen von Home-Verzeichnissen einen
TYPE
Wert von.DIRECTORY
Wenn Sie diese Option aktivieren, müssten Sie den Wert dann explizit auf setzen,FILE
wenn Sie möchtenHomeDirectoryMapEntry
Type
, dass eine Zuordnung ein Dateiziel hat.Typ: S3StorageOptions Objekt
Erforderlich: Nein
- SecurityPolicyName
-
Gibt den Namen der Sicherheitsrichtlinie an, die dem Server zugewiesen ist.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 100 Zeichen.
Pattern:
TransferSecurityPolicy-.+
Erforderlich: Nein
- ServerId
-
Ein vom System zugewiesener eindeutiger Bezeichner für eine Serverinstanz, der der Transfer Family Family-Benutzer zugewiesen ist.
Typ: Zeichenfolge
Längenbeschränkungen: Feste Länge von 19.
Pattern:
s-([0-9a-f]{17})
Erforderlich: Ja
- StructuredLogDestinations
-
Gibt die Protokollgruppen an, an die Ihre Serverprotokolle gesendet werden.
Um eine Protokollgruppe anzugeben, müssen Sie die ARN für eine bestehende Protokollgruppe angeben. In diesem Fall lautet das Format der Protokollgruppe wie folgt:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
Beispiel:
arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
Wenn Sie zuvor eine Protokollgruppe für einen Server angegeben haben, können Sie diese löschen und somit die strukturierte Protokollierung deaktivieren, indem Sie in einem
update-server
Aufruf einen leeren Wert für diesen Parameter angeben. Beispielsweise:update-server --server-id s-1234567890abcdef0 --structured-log-destinations
Typ: Zeichenfolge-Array
Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 1 Element.
Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.
Pattern:
arn:\S+
Erforderlich: Nein
- WorkflowDetails
-
Gibt die Workflow-ID für den zuzuweisenden Workflow und die für die Ausführung des Workflows verwendete Ausführungsrolle an.
Zusätzlich zu einem Workflow, der ausgeführt wird, wenn eine Datei vollständig hochgeladen wurde, kann
WorkflowDetails
auch eine Workflow-ID (und Ausführungsrolle) für einen Workflow enthalten, der beim teilweisen Upload ausgeführt werden soll. Ein teilweiser Upload erfolgt, wenn die Serversitzung unterbrochen wird, während die Datei noch hochgeladen wird.Um einen zugeordneten Workflow von einem Server zu entfernen, können Sie einen leeren
OnUpload
-Datentyp bereitstellen, wie im folgenden Beispiel.aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'
Typ: WorkflowDetails Objekt
Erforderlich: Nein
Antwortsyntax
{
"ServerId": "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.
- ServerId
-
Eine vom System zugewiesene eindeutige Kennung für einen Server, dem der Transfer Family Family-Benutzer zugewiesen ist.
Typ: Zeichenfolge
Längenbeschränkungen: Feste Länge von 19.
Pattern:
s-([0-9a-f]{17})
Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.
- AccessDeniedException
-
Sie haben keinen ausreichenden Zugriff zum Durchführen dieser Aktion.
HTTPStatuscode: 400
- ConflictException
-
Diese Ausnahme wird ausgelöst, wenn der für einen Server aufgerufen
UpdateServer
wird, für den das Dateiübertragungsprotokoll aktiviert ist VPC und der Endpunkttyp des Servers nicht verfügbarVpcEndpointID
ist.HTTPStatuscode: 400
- 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 die Rolle eines Servers aktualisiert.
Beispielanforderung
{
"EndpointDetails": {
"VpcEndpointId": "vpce-01234f056f3g13",
"LoggingRole": "CloudWatchS3Events",
"ServerId": "s-01234567890abcdef"
}
}
Beispiel
Im folgenden Beispiel werden alle zugehörigen Workflows vom Server entfernt.
Beispielanforderung
aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'
Beispiel
Dies ist eine Beispielantwort für diesen API Anruf.
Beispielantwort
{
"ServerId": "s-01234567890abcdef"
}
Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: