StartTaskExecution
启动 Amazon DataSync 传输任务。对于每个任务，您一次只能运行一个任务执行。
任务执行分为几个步骤。有关更多信息，请参阅任务执行状态。
重要
如果您计划向或从某个 Amazon S3 位置传输数据，请在开始之前先查看DataSync 会如何影响您的 S3 请求费用以及DataSync 定价页面
请求语法
{
"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"
}
}请求参数
有关所有操作的通用参数的信息，请参阅常用参数。
请求接受采用 JSON 格式的以下数据。
- Excludes
-
指定筛选规则列表，用于确定从任务中排除哪些文件。该列表包含一个由要排除的模式组成的筛选字符串。模式由“|”（即竖线）分隔，例如
"/folder1|/folder2"。类型：FilterRule 对象数组
数组成员：最少 0 个物品。最多 1 项。
必需：否
- Includes
-
指定筛选规则列表，用于确定运行任务时要包含哪些文件。该模式应包含一个由要包含的模式组成的筛选字符串。模式由“|”（即竖线）分隔，例如
"/folder1|/folder2"。类型：FilterRule 对象数组
数组成员：最少 0 个物品。最多 1 项。
必需：否
- ManifestConfig
-
配置清单，即您希望 DataSync 传输的文件或对象的列表。有关详细信息和配置示例，请参阅使用清单指定 DataSync 传输的内容。
使用此参数时，您的调用者身份（您用于 DataSync 的角色）必须拥有
iam:PassRole权限。AWSDataSyncFullAccess 策略包含此权限。要移除清单配置，请将此参数指定为空值。
类型：ManifestConfig 对象
必需：否
- OverrideOptions
-
指明您的传输任务是如何配置的。这些选项包括 DataSync 在传输过程中如何处理文件、对象及其关联的元数据。您还可以指定如何验证数据完整性、为任务设置带宽限制等其他选项。
每个选项都有一个默认值。除非有必要，否则在调用 StartTaskExecution 之前不必配置任何选项。
您还可以在每次执行任务时覆盖任务选项。例如，您可能希望为单次执行调整
LogLevel。类型：Options 对象
必需：否
- Tags
-
指定要应用于代表任务执行的 Amazon 资源名称（ARN）的标签。
标签是键值对，帮助您管理、筛选和搜索 DataSync 资源。
类型：TagListEntry 对象数组
数组成员：最少 0 个物品。最多 50 项。
必需：否
- TaskArn
-
指定您要启动的任务的 Amazon 资源名称（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}$必需：是
- TaskReportConfig
-
指定您希望如何配置提供了有关 DataSync 传输详细信息的任务报告。有关更多信息，请参阅使用任务报告监控您的 DataSync 传输。
使用此参数时，您的调用者身份（您用于 DataSync 的角色）必须拥有
iam:PassRole权限。AWSDataSyncFullAccess 策略包含此权限。要移除任务报告配置，请将此参数指定为空。
类型：TaskReportConfig 对象
必需：否
响应语法
{
"TaskExecutionArn": "string"
}响应元素
如果此操作成功，则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- TaskExecutionArn
-
运行任务执行的 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}/execution/exec-[0-9a-f]{17}$
错误
有关所有操作的常见错误信息，请参阅 常见错误。
- InternalException
-
当 Amazon DataSync 服务中发生错误时，会引发此异常。
HTTP 状态代码：500
- InvalidRequestException
-
当客户端提交格式错误的请求时，会引发此异常。
HTTP 状态代码：400
示例
示例请求
以下示例使用指定任务的默认选项开启任务执行。
{ "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" }
示例响应
此示例说明了 StartAskExecution 的一种用法。
{ "TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f" }
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息，请参阅以下内容：