StartTaskExecution

Startet eine AWS DataSync Übertragungsaufgabe. Für jede Aufgabe können Sie jeweils nur eine Aufgabenausführung ausführen.

Die Ausführung einer Aufgabe besteht aus mehreren Schritten. Weitere Informationen finden Sie unter Status der Aufgabenausführung.

Wichtig

Wenn Sie planen, Daten zu oder von einem Amazon S3 S3-Standort zu übertragen, lesen Sie zunächst, wie sich dies auf Ihre S3-Anforderungsgebühren auswirken DataSync kann, sowie auf der DataSync Preisseite.

Anforderungssyntax

{
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "ManifestConfig": { 
      "Action": "string",
      "Format": "string",
      "Source": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "ManifestObjectPath": "string",
            "ManifestObjectVersionId": "string",
            "S3BucketArn": "string"
         }
      }
   },
   "OverrideOptions": { 
      "Atime": "string",
      "BytesPerSecond": number,
      "Gid": "string",
      "LogLevel": "string",
      "Mtime": "string",
      "ObjectTags": "string",
      "OverwriteMode": "string",
      "PosixPermissions": "string",
      "PreserveDeletedFiles": "string",
      "PreserveDevices": "string",
      "SecurityDescriptorCopyFlags": "string",
      "TaskQueueing": "string",
      "TransferMode": "string",
      "Uid": "string",
      "VerifyMode": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TaskArn": "string",
   "TaskReportConfig": { 
      "Destination": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "S3BucketArn": "string",
            "Subdirectory": "string"
         }
      },
      "ObjectVersionIds": "string",
      "OutputType": "string",
      "Overrides": { 
         "Deleted": { 
            "ReportLevel": "string"
         },
         "Skipped": { 
            "ReportLevel": "string"
         },
         "Transferred": { 
            "ReportLevel": "string"
         },
         "Verified": { 
            "ReportLevel": "string"
         }
      },
      "ReportLevel": "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.

Excludes

Gibt eine Liste von Filterregeln an, die bestimmt, welche Dateien von einer Aufgabe ausgeschlossen werden sollen. Die Liste enthält eine einzelne Filterzeichenfolge, die aus den auszuschließenden Mustern besteht. Die Muster werden durch "|" (also eine Pipe) abgegrenzt. Beispiel: "/folder1|/folder2".

Typ: Array von FilterRule-Objekten

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

Erforderlich: Nein

Includes

Gibt eine Liste von Filterregeln an, die bestimmt, welche Dateien bei der Ausführung einer Aufgabe berücksichtigt werden sollen. Das Muster sollte eine einzelne Filterzeichenfolge enthalten, die aus den einzuschließenden Mustern besteht. Die Muster werden durch "|" (also eine Pipe) abgegrenzt. Beispiel: "/folder1|/folder2".

Typ: Array von FilterRule-Objekten

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

Erforderlich: Nein

ManifestConfig

Konfiguriert ein Manifest, bei dem es sich um eine Liste von Dateien oder Objekten handelt, die Sie übertragen DataSync möchten. Weitere Informationen und Konfigurationsbeispiele finden Sie unter Angabe der DataSync Übertragungen mithilfe eines Manifests.

Wenn Sie diesen Parameter verwenden, muss Ihre Anruferidentität (die Rolle, DataSync mit der Sie ihn verwenden) über die iam:PassRole entsprechende Berechtigung verfügen. Die AWSDataSyncFullAccessRichtlinie beinhaltet diese Erlaubnis.

Um eine Manifestkonfiguration zu entfernen, geben Sie diesen Parameter mit einem leeren Wert an.

Typ: ManifestConfig Objekt

Erforderlich: Nein

OverrideOptions

Gibt an, wie Ihre Übertragungsaufgabe konfiguriert ist. Zu diesen Optionen gehört, DataSync wie mit Dateien, Objekten und den zugehörigen Metadaten während der Übertragung umgegangen wird. Sie können unter anderem auch angeben, wie die Datenintegrität überprüft werden soll, Bandbreitenlimits für Ihre Aufgabe festlegen.

Jede Option hat einen Standardwert. Sofern Sie dies nicht möchten, müssen Sie vor dem Anruf keine Option konfigurieren StartTaskExecution.

Sie können Ihre Aufgabenoptionen auch für jede Aufgabenausführung überschreiben. Möglicherweise möchten Sie die LogLevel für eine einzelne Ausführung anpassen.

Typ: Options Objekt

Erforderlich: Nein

Tags

Gibt die Tags an, die Sie auf den Amazon-Ressourcennamen (ARN) anwenden möchten, der die Aufgabenausführung darstellt.

Tags sind Schlüssel-Wert-Paare, die Ihnen helfen, Ihre DataSync Ressourcen zu verwalten, zu filtern und nach ihnen zu suchen.

Typ: Array von TagListEntry-Objekten

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

Erforderlich: Nein

TaskArn

Gibt den Amazon-Ressourcennamen (ARN) der Aufgabe an, die Sie starten möchten.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 128 Zeichen.

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$

Erforderlich: Ja

TaskReportConfig

Gibt an, wie Sie einen Aufgabenbericht konfigurieren möchten, der detaillierte Informationen zu Ihrer DataSync Übertragung enthält. Weitere Informationen finden Sie unter Überwachen Ihrer DataSync Übertragungen mit Aufgabenberichten.

Wenn Sie diesen Parameter verwenden, muss Ihre Anruferidentität (die Rolle, DataSync mit der Sie ihn verwenden) über die iam:PassRole entsprechende Berechtigung verfügen. Die AWSDataSyncFullAccessRichtlinie beinhaltet diese Erlaubnis.

Um eine Task-Berichtskonfiguration zu entfernen, geben Sie diesen Parameter als leer an.

Typ: TaskReportConfig Objekt

Erforderlich: Nein

Antwortsyntax

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

TaskExecutionArn

Der ARN der laufenden Aufgabenausführung.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 128 Zeichen.

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

InternalException

Diese Ausnahme wird ausgelöst, wenn im AWS DataSync Dienst ein Fehler auftritt.

HTTP Status Code: 500

InvalidRequestException

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

HTTP Status Code: 400

Beispiele

Beispielanforderung

Im folgenden Beispiel wird eine Aufgabenausführung mit den Standardoptionen für die angegebene Aufgabe gestartet.

{
    "OverrideOptions": {
        "Atime": "BEST_EFFORT",
        "BytesPerSecond": 1000,
        "Gid": "NONE",
        "Mtime": "PRESERVE",
        "PosixPermissions": "PRESERVE",
        "PreserveDevices": "NONE",
        "PreserveDeletedFiles": "PRESERVE",
        "Uid": "NONE",
        "VerifyMode": "POINT_IN_TIME_CONSISTENT"
    },
    "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}

Beispielantwort

Dieses Beispiel veranschaulicht eine Verwendung von StartTaskExecution.

{
  "TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f"
}

Weitere Informationen finden Sie unter:

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

• AWS -Befehlszeilenschnittstelle

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK für JavaScript V3

• AWS SDK for PHP V3

• AWS SDK für Python

• AWS SDK for Ruby V3