本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
設定任務，定義 AWS DataSync 資料傳輸的位置和方式。
任務包含來源位置、目的地位置和傳輸選項 （例如頻寬限制、排程等）。
重要
如果您打算在 Amazon S3 位置之間傳輸資料，請在開始之前檢閱 DataSync 如何影響您的 S3 請求費用和 DataSync 定價頁面
請求語法
{
"CloudWatchLogGroupArn": "string",
"DestinationLocationArn": "string",
"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"
}
}
},
"Name": "string",
"Options": {
"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"
},
"Schedule": {
"ScheduleExpression": "string",
"Status": "string"
},
"SourceLocationArn": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"TaskMode": "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"
}
}請求參數
如需所有動作的一般參數資訊，請參閱《Common Parameters》。
請求接受採用 JSON 格式的下列資料。
- CloudWatchLogGroupArn
-
指定 Amazon CloudWatch 日誌群組的 Amazon Resource Name (ARN)，以監控您的任務。
對於增強型模式任務，您不需要指定任何項目。DataSync 會自動將日誌傳送至名為 的 CloudWatch 日誌群組
/aws/datasync。如需詳細資訊，請參閱使用 CloudWatch Logs 監控資料傳輸。
類型：字串
長度限制條件：長度上限為 562。
模式：
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$必要：否
- DestinationLocationArn
-
指定傳輸目的地位置的 ARN。
類型：字串
長度限制：長度上限為 128。
模式：
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$必要：是
- Excludes
-
指定排除篩選條件，以定義您不希望 DataSync 傳輸之來源位置中的檔案、物件和資料夾。如需詳細資訊和範例，請參閱使用篩選條件指定 DataSync 傳輸的內容。
類型：FilterRule 物件陣列
陣列成員：項目數下限為 0。項目數上限為 1。
必要：否
- Includes
-
指定包含篩選條件，可定義您要 DataSync 傳輸之來源位置中的檔案、物件和資料夾。如需詳細資訊和範例，請參閱使用篩選條件指定 DataSync 傳輸的內容。
類型：FilterRule 物件陣列
陣列成員：項目數下限為 0。項目數上限為 1。
必要：否
- ManifestConfig
-
設定資訊清單，這是您希望 DataSync 傳輸的檔案或物件清單。如需詳細資訊和組態範例，請參閱使用資訊清單指定 DataSync 傳輸的內容。
使用此參數時，您的呼叫者身分 （與 DataSync 搭配使用的角色） 必須具有
iam:PassRole許可。AWSDataSyncFullAccess 政策包含此許可。類型：ManifestConfig 物件
必要：否
- Name
-
指定任務的名稱。
類型：字串
長度限制：長度下限為 0。長度上限為 256。
模式：
^[a-zA-Z0-9\s+=._:@/-]+$必要：否
- Options
-
指定任務的設定，例如保留檔案中繼資料、驗證資料完整性等選項。
類型：Options 物件
必要：否
- Schedule
-
指定您希望任務何時執行的排程。如需詳細資訊，請參閱任務排程。
類型：TaskSchedule 物件
必要：否
- SourceLocationArn
-
指定傳輸來源位置的 ARN。
類型：字串
長度限制：長度上限為 128。
模式：
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$必要：是
- Tags
-
指定您要套用至任務的標籤。
標籤是有助於管理、篩選和搜尋 DataSync 資源的鍵值對。
類型：TagListEntry 物件陣列
陣列成員：項目數下限為 0。項目數上限為 50。
必要：否
- TaskMode
-
指定下列其中一個任務模式，以進行資料傳輸：
-
ENHANCED- 傳輸幾乎沒有限制的物件數量，其效能比基本模式更高。增強型模式任務透過並行列出、準備、傳輸和驗證資料來最佳化資料傳輸程序。增強型模式目前可用於 Amazon S3 位置之間的傳輸。注意
若要建立增強型模式任務，您用來呼叫
CreateTask操作的 IAM 角色必須具有iam:CreateServiceLinkedRole許可。 -
BASIC（預設） - 在儲存體和所有其他支援的 DataSync 位置之間 AWS 傳輸檔案或物件。基本模式任務會受到資料集中檔案、物件和目錄數量的配額限制。基本模式會依序準備、傳輸和驗證資料，因此比大多數工作負載的增強型模式慢。
如需詳細資訊，請參閱了解任務模式差異。
類型：字串
有效值:
BASIC | ENHANCED必要：否
-
- TaskReportConfig
-
指定您要如何設定任務報告，以提供 DataSync 傳輸的詳細資訊。如需詳細資訊，請參閱使用任務報告監控 DataSync 傳輸。
使用此參數時，您的呼叫者身分 （與 DataSync 搭配使用的角色） 必須具有
iam:PassRole許可。AWSDataSyncFullAccess 政策包含此許可。類型：TaskReportConfig 物件
必要：否
回應語法
{
"TaskArn": "string"
}回應元素
如果動作成功，則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- TaskArn
-
任務的 Amazon Resource Name (ARN)。
類型：字串
長度限制：長度上限為 128。
模式：
^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}$
錯誤
如需所有動作常見錯誤的資訊，請參閱常見錯誤。
- InternalException
-
當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。
HTTP 狀態碼：500
- InvalidRequestException
-
當用戶端提交格式不正確的請求時，就會擲出此例外狀況。
HTTP 狀態碼：400
範例
增強型模式任務的範例請求
下列範例會建立使用增強模式的 DataSync 任務。
與建立基本模式任務時不同，您不需要指定 Amazon CloudWatch 日誌群組。透過增強型模式任務，DataSync 會自動將任務日誌傳送至名為 的日誌群組/aws/datasync。如果您的 中不存在該日誌群組 AWS 區域，DataSync 會在您建立任務時代表您建立日誌群組。
{
"SourceLocationArn": "arn:aws:datasync:us-east-1:111222333444:location/1111aaaa2222bbbb3",
"DestinationLocationArn": "arn:aws:datasync:us-east-1:111222333444:location/0000zzzz1111yyyy2",
"Name": "My Enhanced mode task",
"TaskMode": "ENHANCED",
"Options": {
"TransferMode": "CHANGED",
"VerifyMode": "ONLY_FILES_TRANSFERRED",
"ObjectTags": "PRESERVE",
"LogLevel": "TRANSFER"
}
}基本模式任務的範例請求
下列範例會建立使用基本模式的 DataSync 任務。
{
"SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3",
"DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2",
"Name": "My Basic mode task",
"TaskMode": "BASIC",
"Options": {
"Atime": "BEST_EFFORT",
"Gid": "NONE",
"Mtime": "PRESERVE",
"PosixPermissions": "PRESERVE",
"PreserveDevices": "NONE",
"PreserveDeletedFiles": "PRESERVE",
"Uid": "NONE",
"VerifyMode": "ONLY_FILES_TRANSFERRED"
},
"Schedule": {
"ScheduleExpression": "0 12 ? * SUN,WED *"
},
"CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group:/log-group-name:*",
"Tags": [
{
"Key": "Name",
"Value": "Migration-wave-1"
}
]
}回應範例
下列回應包含已建立任務的 ARN。
{
"TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
