2023 年 12 月 7 日より、バージョン 1 DataSync のエージェントは廃止されます。 DataSync コンソールの [エージェント] ページをチェックして、影響を受けるエージェントがいないか確認してください。その場合は、データ転送やストレージ検出の中断を避けるため、その前にそれらのエージェントを交換してください。さらにサポートが必要な場合は、お問い合わせくださいAWS Support
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
StartTaskExecution
AWS DataSync転送タスクを開始します。各タスクでは、一度に 1 つのタスク実行しか実行できません。
タスク実行には複数のフェーズがあります。詳細については、「タスク実行ステータス」を参照してください。
重要
Amazon S3 ロケーションとの間でデータを転送する予定がある場合は、開始する前に S3 DataSync DataSync リクエスト料金と料金ページにどのような影響があるかを確認してください
リクエストの構文
{
"Excludes": [
{
"FilterType": "string",
"Value": "string"
}
],
"Includes": [
{
"FilterType": "string",
"Value": "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
-
タスクから除外するファイルを決定するフィルタルールのリストを指定します。リストには、除外するパターンで構成される 1 つのフィルター文字列が含まれています。パターンは「|」(パイプ) で区切られます (例:
"/folder1|/folder2")。型: FilterRule オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
必須: いいえ
- Includes
-
タスクの実行時にどのファイルを含めるかを決定するフィルタルールのリストを指定します。パターンには、インクルードするパターンで構成される 1 つのフィルター文字列が含まれる必要があります。パターンは「|」(パイプ) で区切られます (例:
"/folder1|/folder2")。型: FilterRule オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
必須: いいえ
- OverrideOptions
-
転送タスクの設定方法を示します。これらのオプションには、転送中のファイル、オブジェクト、 DataSync および関連するメタデータの処理方法が含まれます。また、データの整合性の検証方法や、タスクの帯域幅制限の設定方法なども指定できます。
各オプションにはデフォルト値があります。必要でない限り、タスクを開始する前にこれらのオプションを設定する必要はありません。
型: 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 転送に関する詳細情報を提供するタスクレポートの設定方法を指定します。
型: 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
-
この例外は、AWS 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" }
レスポンス例
この例は、の 1 つの使用法を示しています StartTaskExecution。
{ "TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f" }
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
