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.
Gibt eine Liste der Profile für Ihr System zurück. Wenn Sie die Ergebnisse auf eine bestimmte Zahl beschränken möchten, geben Sie einen Wert für den MaxResults Parameter an. Wenn Sie den Befehl zuvor ausgeführt haben und einen Wert für erhalten habenNextToken, können Sie diesen Wert angeben, um die Profile dort aufzulisten, wo Sie aufgehört haben.
Anforderungssyntax
{
"MaxResults": number,
"NextToken": "string",
"ProfileType": "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.
- MaxResults
-
Die maximale Anzahl von Profilen, die zurückgegeben werden sollen.
Typ: Ganzzahl
Gültiger Bereich: Mindestwert 1. Maximaler Wert von 1 000.
Erforderlich: Nein
- NextToken
-
Wenn es zusätzliche Ergebnisse gibt, die nicht zurückgegeben wurden, wird ein
NextTokenParameter zurückgegeben. Sie können diesen Wert für einen nachfolgenden Aufruf verwenden,ListProfilesum mit dem Auflisten der Ergebnisse fortzufahren.Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge von 6144.
Erforderlich: Nein
- ProfileType
-
Gibt an, ob nur
LOCAL- oder nurPARTNER-Typprofile aufgelistet werden sollen. Sind diese nicht in der Anforderung nicht, listet der Befehl alle Profilarten auf.Typ: Zeichenfolge
Zulässige Werte:
LOCAL | PARTNERErforderlich: Nein
Antwortsyntax
{
"NextToken": "string",
"Profiles": [
{
"Arn": "string",
"As2Id": "string",
"ProfileId": "string",
"ProfileType": "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.
- NextToken
-
Gibt ein Token zurück, das Sie verwenden können, um
ListProfileserneut aufzurufen und zusätzliche Ergebnisse zu erhalten, falls vorhanden.Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge von 6144.
- Profiles
-
Gibt ein Array zurück, in dem jedes Element die Details eines Profils enthält.
Typ: Array von ListedProfile-Objekten
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
- InvalidNextTokenException
-
Der übergebene
NextTokenParameter ist ungültig.HTTPStatuscode: 400
- 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
Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
