翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # StartTaskExecution AWS DataSync 転送タスクを開始します。各タスクでは、一度に 1 つのタスク実行しか実行できません。 タスク実行には複数のステップがあります。詳細については、「[タスクの実行ステータス](https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses)」を参照してください。 **重要** Amazon S3 ロケーションとの間でデータを転送する予定がある場合は、開始する前に [DataSync が S3 リクエスト料金にどのような影響を与えるか](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests)について、および [DataSync 料金ページ](https://aws.amazon.com/datasync/pricing/)を確認してください。 ## リクエストの構文 ``` { "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" } } ``` ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 リクエストは以下のデータを JSON 形式で受け入れます。 ** [Excludes](#API_StartTaskExecution_RequestSyntax) ** タスクから除外するファイルを決定するフィルター規則のリストを指定します。リストには、除外するパターンで構成される 1 つのフィルター文字列が含まれています。パターンは「\$1」(パイプ) で区切られます (例: `"/folder1|/folder2"`)。 タイプ: [FilterRule](API_FilterRule.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。 必須: いいえ ** [Includes](#API_StartTaskExecution_RequestSyntax) ** タスクを実行するときに含めるファイルを決定するフィルター規則のリストを指定します。パターンには、インクルードするパターンで構成される 1 つのフィルター文字列が含まれる必要があります。パターンは「\$1」(パイプ) で区切られます (例: `"/folder1|/folder2"`)。 タイプ: [FilterRule](API_FilterRule.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。 必須: いいえ ** [ManifestConfig](#API_StartTaskExecution_RequestSyntax) ** DataSync が転送するファイルまたはオブジェクトのリストであるマニフェストを設定します。詳細と設定例については、「[Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)」を参照してください。 このパラメータを使用する場合、発信者 ID (DataSync を使用しているロール) には `iam:PassRole` アクセス許可が必要です。[AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) ポリシーには、このアクセス許可が含まれています。 マニフェスト設定を削除するには、このパラメータを空の値で指定します。 タイプ: [ManifestConfig](API_ManifestConfig.md) オブジェクト 必須: いいえ ** [OverrideOptions](#API_StartTaskExecution_RequestSyntax) ** 転送タスクがどのように構成されているかを示します。これらのオプションには、転送中に DataSync がファイル、オブジェクト、および関連するメタデータを処理する方法が含まれます。また、データの整合性の検証方法や、タスクの帯域幅制限の設定方法なども指定できます。 各オプションにはデフォルト値があります。必要な場合を除き、[StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) を呼び出す前にこれらのオプションを設定する必要はありません。 これらのタスクオプションは各タスクを実行するたびにオーバーライドできます。例えば、個々の実行に合わせて `LogLevel` を調整することができます。 タイプ: [Options](API_Options.md) オブジェクト 必須: いいえ ** [Tags](#API_StartTaskExecution_RequestSyntax) ** タスク実行を表す Amazon リソースネーム (ARN) に適用するタグを指定します。 *タグ*は、DataSync リソースの管理、フィルタリング、検索に役立つキーと値のペアです。 タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。 必須: いいえ ** [TaskArn](#API_StartTaskExecution_RequestSyntax) ** 開始するタスクの Amazon リソースネーム (ARN) を指定します。 タイプ: 文字列 長さの制約: 最大長は 128 です。 パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}$` 必須: はい ** [TaskReportConfig](#API_StartTaskExecution_RequestSyntax) ** DataSync 転送に関する詳細情報を提供するタスクレポートの構成方法を指定します。詳細については、「[Monitoring your DataSync transfers with task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)」を参照してください。 このパラメータを使用する場合、発信者 ID (DataSync を使用しているロール) には `iam:PassRole` アクセス許可が必要です。[AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) ポリシーには、このアクセス許可が含まれています。 タスクレポート設定を削除するには、このパラメータを空として指定します。 タイプ: [TaskReportConfig](API_TaskReportConfig.md) オブジェクト 必須: いいえ ## レスポンスの構文 ``` { "TaskExecutionArn": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [TaskExecutionArn](#API_StartTaskExecution_ResponseSyntax) ** 進行中のタスク実行の ARN。 タイプ: 文字列 長さの制約: 最大長は 128 です。 パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|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}$` ## エラー すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。 ** 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" } ``` ### レスポンス例 この例は、StartTaskExecution 使用方法を 1 つ示しています。 ``` { "TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f" } ``` ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/StartTaskExecution) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/StartTaskExecution) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/StartTaskExecution) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/StartTaskExecution) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/StartTaskExecution) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/StartTaskExecution) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/StartTaskExecution) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/StartTaskExecution) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/StartTaskExecution) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/StartTaskExecution)