DescribeExecution - AWS Transfer Family

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.

DescribeExecution

Sie können DescribeExecution damit die Details der Ausführung des angegebenen Workflows überprüfen.

Anmerkung

Dieser API Aufruf gibt nur Details für Workflows zurück, die gerade bearbeitet werden.

Wenn Sie eine ID für eine Ausführung angeben, die nicht in Bearbeitung ist, oder wenn die Ausführung nicht mit der angegebenen Workflow-ID übereinstimmt, erhalten Sie eine ResourceNotFound Ausnahme.

Anforderungssyntax

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

ExecutionId

Eine eindeutige Kennung für die Ausführung eines Workflows.

Typ: Zeichenfolge

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

Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

Erforderlich: Ja

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

{ "Execution": { "ExecutionId": "string", "ExecutionRole": "string", "InitialFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", "Etag": "string", "Key": "string", "VersionId": "string" } }, "LoggingConfiguration": { "LoggingRole": "string", "LogGroupName": "string" }, "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Results": { "OnExceptionSteps": [ { "Error": { "Message": "string", "Type": "string" }, "Outputs": "string", "StepType": "string" } ], "Steps": [ { "Error": { "Message": "string", "Type": "string" }, "Outputs": "string", "StepType": "string" } ] }, "ServiceMetadata": { "UserDetails": { "ServerId": "string", "SessionId": "string", "UserName": "string" } }, "Status": "string" }, "WorkflowId": "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.

Execution

Die Struktur, die die Details der Workflow-Ausführung enthält.

Typ: DescribedExecution Objekt

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.

HTTPStatuscode: 500

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: