CreateWorkflow - AWS Transfer Family
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerBeispieleWeitere 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.

CreateWorkflow

Ermöglicht es Ihnen, einen Workflow mit bestimmten Schritten und Schrittdetails zu erstellen, die der Workflow nach Abschluss der Dateiübertragung aufruft. Nachdem Sie einen Workflow erstellt haben, können Sie den erstellten Workflow beliebigen Transferservern zuordnen, indem Sie das Feld workflow-details in CreateServer- und UpdateServer-Vorgängen angeben.

Anforderungssyntax

{
   "Description": "string",
   "OnExceptionSteps": [ 
      { 
         "CopyStepDetails": { 
            "DestinationFileLocation": { 
               "EfsFileLocation": { 
                  "FileSystemId": "string",
                  "Path": "string"
               },
               "S3FileLocation": { 
                  "Bucket": "string",
                  "Key": "string"
               }
            },
            "Name": "string",
            "OverwriteExisting": "string",
            "SourceFileLocation": "string"
         },
         "CustomStepDetails": { 
            "Name": "string",
            "SourceFileLocation": "string",
            "Target": "string",
            "TimeoutSeconds": number
         },
         "DecryptStepDetails": { 
            "DestinationFileLocation": { 
               "EfsFileLocation": { 
                  "FileSystemId": "string",
                  "Path": "string"
               },
               "S3FileLocation": { 
                  "Bucket": "string",
                  "Key": "string"
               }
            },
            "Name": "string",
            "OverwriteExisting": "string",
            "SourceFileLocation": "string",
            "Type": "string"
         },
         "DeleteStepDetails": { 
            "Name": "string",
            "SourceFileLocation": "string"
         },
         "TagStepDetails": { 
            "Name": "string",
            "SourceFileLocation": "string",
            "Tags": [ 
               { 
                  "Key": "string",
                  "Value": "string"
               }
            ]
         },
         "Type": "string"
      }
   ],
   "Steps": [ 
      { 
         "CopyStepDetails": { 
            "DestinationFileLocation": { 
               "EfsFileLocation": { 
                  "FileSystemId": "string",
                  "Path": "string"
               },
               "S3FileLocation": { 
                  "Bucket": "string",
                  "Key": "string"
               }
            },
            "Name": "string",
            "OverwriteExisting": "string",
            "SourceFileLocation": "string"
         },
         "CustomStepDetails": { 
            "Name": "string",
            "SourceFileLocation": "string",
            "Target": "string",
            "TimeoutSeconds": number
         },
         "DecryptStepDetails": { 
            "DestinationFileLocation": { 
               "EfsFileLocation": { 
                  "FileSystemId": "string",
                  "Path": "string"
               },
               "S3FileLocation": { 
                  "Bucket": "string",
                  "Key": "string"
               }
            },
            "Name": "string",
            "OverwriteExisting": "string",
            "SourceFileLocation": "string",
            "Type": "string"
         },
         "DeleteStepDetails": { 
            "Name": "string",
            "SourceFileLocation": "string"
         },
         "TagStepDetails": { 
            "Name": "string",
            "SourceFileLocation": "string",
            "Tags": [ 
               { 
                  "Key": "string",
                  "Value": "string"
               }
            ]
         },
         "Type": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

Description

Eine Textbeschreibung für den Workflow.

Typ: Zeichenfolge

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

Pattern: [\w- ]*

Erforderlich: Nein

OnExceptionSteps

Gibt die Schritte (Aktionen) an, die ausgeführt werden sollen, wenn bei der Ausführung des Workflows Fehler auftreten.

Anmerkung

Bei benutzerdefinierten Schritten muss die Lambda-Funktion an den Rückruf sendenFAILURE, um die API Ausnahmeschritte auszulösen. Wenn das Lambda SUCCESS vor dem Timeout nicht sendet, werden außerdem die Ausnahmeschritte ausgeführt.

Typ: Array von WorkflowStep-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Maximale Anzahl von 8 Elementen.

Erforderlich: Nein

Steps

Gibt die Details für die Schritte an, die im angegebenen Workflow enthalten sind.

Das TYPE gibt an, welche der folgenden Aktionen für diesen Schritt ergriffen werden.

  • COPY – Die Datei an einen anderen Ort kopieren.

  • CUSTOM- Führt einen benutzerdefinierten Schritt mit einem AWS Lambda Funktionsziel aus.

  • DECRYPT – Eine Datei entschlüsseln, die vor dem Hochladen verschlüsselt wurde.

  • DELETE – Die Datei löschen.

  • TAG – Der Datei ein Tag hinzufügen.

Anmerkung

Derzeit werden Kopieren und Taggen nur auf S3 unterstützt.

Als Dateispeicherort geben Sie entweder den Amazon S3 S3-Bucket und -Schlüssel oder die EFS Amazon-Dateisystem-ID und den Pfad an.

Typ: Array von WorkflowStep-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Maximale Anzahl von 8 Artikeln.

Erforderlich: Ja

Tags

Schlüssel-Wert-Paare, die zum Gruppieren und Suchen nach Workflows verwendet werden können. Tags sind Metadaten, die zu beliebigen Zwecken an Workflows angefügt werden.

Typ: Array von Tag-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 50 Elemente.

Erforderlich: Nein

Antwortsyntax

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

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.

AccessDeniedException

Sie haben keinen ausreichenden Zugriff zum Durchführen dieser Aktion.

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

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

Sie können Workflow-Schrittinformationen in einer Textdatei speichern und diese Datei dann verwenden, um einen Workflow zu erstellen, wie im folgenden Beispiel gezeigt. Das folgende Beispiel geht davon aus, dass Sie Ihre Workflow-Schritte in example-file.json gespeichert haben (in demselben Ordner, in dem Sie den Befehl ausführen) und dass Sie den Workflow in der Region Nord-Virginia (us-east-1) erstellen möchten. 

aws transfer create-workflow --description "example workflow from a file" --steps file://example-file.json --region us-east-1
// Example file containing workflow steps
[
   {
     "Type": "TAG",
     "TagStepDetails": {
        "Name": "TagStep",
        "Tags": [
          {
            "Key": "name",
            "Value": "testTag"
          }
        ]
     }
   },
   {
     "Type": "COPY",
     "CopyStepDetails": {
        "Name": "CopyStep",
        "DestinationFileLocation": {
        "S3FileLocation": {
           "Bucket": "DOC-EXAMPLE-BUCKET",
           "Key": "DOC-EXAMPLE-KEY/"
                  }
        },
        "OverwriteExisting": "TRUE",
        "SourceFileLocation": "${original.file}"
     }
   },
   {
     "Type": "DELETE",
     "DeleteStepDetails":{
     "Name":"DeleteStep",
     "SourceFileLocation": "${original.file}"
     }
   }
]

Beispiel

Der CreateWorkflow Anruf gibt die Workflow-ID für den neuen Workflow zurück.

Beispielantwort

{
    "WorkflowId": "w-1234abcd5678efghi"
}

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: