ListExecutions - AWS Transfer Family
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerWeitere 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.

ListExecutions

Listet alle laufenden Ausführungen für den angegebenen Workflow auf.

Anmerkung

Wenn die angegebene Workflow-ID nicht gefunden werden kann, wird eine ListExecutions ResourceNotFound Ausnahme zurückgegeben.

Anforderungssyntax

{
   "MaxResults": number,
   "NextToken": "string",
   "WorkflowId": "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.

MaxResults

Gibt die maximale Anzahl zurückzugebender Ausführungen an.

Typ: Ganzzahl

Gültiger Bereich: Mindestwert 1. Maximaler Wert von 1 000.

Erforderlich: Nein

NextToken

ListExecutionsgibt den NextToken Parameter in der Ausgabe zurück. Sie können den NextToken Parameter dann in einem nachfolgenden Befehl übergeben, um weitere Ausführungen aufzulisten.

Dies ist beispielsweise für die Paginierung nützlich. Wenn Sie 100 Ausführungen für einen Workflow haben, möchten Sie vielleicht nur die ersten 10 auflisten. Wenn ja, rufen Sie die API auf, indem Sie Folgendes max-results angeben:

aws transfer list-executions --max-results 10

Dadurch werden Details für die ersten 10 Ausführungen sowie der Zeiger (NextToken) auf die elfte Ausführung zurückgegeben. Sie können die API jetzt erneut aufrufen und den NextToken Wert angeben, den Sie erhalten haben:

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

Dieser Aufruf gibt die nächsten 10 Ausführungen zurück, von der 11. bis zur 20. Sie können den Anruf dann wiederholen, bis die Details für alle 100 Ausführungen zurückgegeben wurden.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge von 6144.

Erforderlich: Nein

WorkflowId

Eine eindeutige Kennung für den Workflow.

Typ: Zeichenfolge

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

Pattern: w-([a-z0-9]{17})

Erforderlich: Ja

Antwortsyntax

{
   "Executions": [ 
      { 
         "ExecutionId": "string",
         "InitialFileLocation": { 
            "EfsFileLocation": { 
               "FileSystemId": "string",
               "Path": "string"
            },
            "S3FileLocation": { 
               "Bucket": "string",
               "Etag": "string",
               "Key": "string",
               "VersionId": "string"
            }
         },
         "ServiceMetadata": { 
            "UserDetails": { 
               "ServerId": "string",
               "SessionId": "string",
               "UserName": "string"
            }
         },
         "Status": "string"
      }
   ],
   "NextToken": "string",
   "WorkflowId": "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.

Executions

Gibt die Details für jede Ausführung in einem ListedExecution Array zurück.

Typ: Array von ListedExecution-Objekten

NextToken

ListExecutionsgibt den NextToken Parameter in der Ausgabe zurück. Sie können den NextToken Parameter dann in einem nachfolgenden Befehl übergeben, um weitere Ausführungen aufzulisten.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge von 6144.

WorkflowId

Eine eindeutige Kennung für den Workflow.

Typ: Zeichenfolge

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

Pattern: w-([a-z0-9]{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

InvalidNextTokenException

Der übergebene NextToken Parameter ist ungültig.

HTTP Status Code: 400

InvalidRequestException

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

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

Weitere Informationen finden Sie unter:

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