翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # DescribeTask AWS DataSync がデータを転送する場所と方法を定義する*タスク*に関する情報を提供します。 ## リクエストの構文 ``` { "TaskArn": "string" } ``` ## リクエストパラメーターすべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。リクエストは以下のデータを JSON 形式で受け入れます。 ** [TaskArn](#API_DescribeTask_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}$` 必須: はい ## レスポンスの構文 ``` { "CloudWatchLogGroupArn": "string", "CreationTime": number, "CurrentTaskExecutionArn": "string", "DestinationLocationArn": "string", "DestinationNetworkInterfaceArns": [ "string" ], "ErrorCode": "string", "ErrorDetail": "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" }, "ScheduleDetails": { "DisabledBy": "string", "DisabledReason": "string", "StatusUpdateTime": number }, "SourceLocationArn": "string", "SourceNetworkInterfaceArns": [ "string" ], "Status": "string", "TaskArn": "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" } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CloudWatchLogGroupArn](#API_DescribeTask_ResponseSyntax) ** タスクをモニタリングするための Amazon CloudWatch ロググループの Amazon リソースネーム (ARN)。詳細については、「[Monitoring data transfers with Amazon CloudWatch Logs](https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html)」を参照してください。タイプ: 文字列長さの制約: 最大長は 562 です。パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$` ** [CreationTime](#API_DescribeTask_ResponseSyntax) ** タスクが作成された時刻。タイプ: タイムスタンプ ** [CurrentTaskExecutionArn](#API_DescribeTask_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}$` ** [DestinationLocationArn](#API_DescribeTask_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}:location/loc-[0-9a-z]{17}$` ** [DestinationNetworkInterfaceArns](#API_DescribeTask_ResponseSyntax) ** DataSync が送信先用に作成された[ネットワークインターフェイス](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces)の ARN。タイプ: 文字列の配列長さの制約: 最大長は 128 です。パターン: `^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$` ** [ErrorCode](#API_DescribeTask_ResponseSyntax) ** タスクに問題がある場合は、エラーコードを使用して問題のトラブルシューティングに役立てることができます。詳細については、「[Troubleshooting issues with DataSync transfers](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html)」を参照してください。タイプ: 文字列 ** [ErrorDetail](#API_DescribeTask_ResponseSyntax) ** タスクに問題がある場合は、エラーの詳細を使用して問題のトラブルシューティングに役立てることができます。詳細については、「[Troubleshooting issues with DataSync transfers](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html)」を参照してください。タイプ: 文字列 ** [Excludes](#API_DescribeTask_ResponseSyntax) ** DataSync に転送してほしくないソースの場所内のファイル、オブジェクト、フォルダを定義する除外フィルター。詳細と例については、「[Specifying what DataSync transfers by using filters](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)」を参照してください。タイプ: [FilterRule](API_FilterRule.md) オブジェクトの配列配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。 ** [Includes](#API_DescribeTask_ResponseSyntax) ** DataSync が転送するソースの場所内のファイル、オブジェクト、フォルダを定義するフィルターが含まれます。詳細と例については、「[Specifying what DataSync transfers by using filters](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)」を参照してください。タイプ: [FilterRule](API_FilterRule.md) オブジェクトの配列配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。 ** [ManifestConfig](#API_DescribeTask_ResponseSyntax) ** DataSync の転送を希望するファイルまたはオブジェクトを一覧表示するマニフェストを設定します。詳細については、「[Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)」を参照してください。タイプ: [ManifestConfig](API_ManifestConfig.md) オブジェクト ** [Name](#API_DescribeTask_ResponseSyntax) ** タスクの名前。タイプ: 文字列長さの制約: 最小長は 0 です。最大長は 256 です。パターン: `^[a-zA-Z0-9\s+=._:@/-]+$` ** [Options](#API_DescribeTask_ResponseSyntax) ** タスクの設定。例えば、どのファイルメタデータが保持されるか、転送終了時にデータ整合性がどのように検証されるか、帯域幅の制限などです。タイプ: [Options](API_Options.md) オブジェクト ** [Schedule](#API_DescribeTask_ResponseSyntax) ** タスクを実行するタイミングのスケジュール。詳細については、「[タスクのスケジュール](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)」を参照してください。タイプ: [TaskSchedule](API_TaskSchedule.md) オブジェクト ** [ScheduleDetails](#API_DescribeTask_ResponseSyntax) ** [タスクスケジュール](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)の詳細。タイプ: [TaskScheduleDetails](API_TaskScheduleDetails.md) オブジェクト ** [SourceLocationArn](#API_DescribeTask_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}:location/loc-[0-9a-z]{17}$` ** [SourceNetworkInterfaceArns](#API_DescribeTask_ResponseSyntax) ** DataSync がソースの場所用に作成した[ネットワークインターフェイス](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces)の ARNs。タイプ: 文字列の配列長さの制約: 最大長は 128 です。パターン: `^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$` ** [Status](#API_DescribeTask_ResponseSyntax) ** タスクのステータス。各ステータスの意味については、「[Task statuses](https://docs.aws.amazon.com/datasync/latest/userguide/create-task-how-to.html#understand-task-creation-statuses)」を参照してください。タイプ: 文字列有効な値：`AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE` ** [TaskArn](#API_DescribeTask_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}$` ** [TaskMode](#API_DescribeTask_ResponseSyntax) ** 使用しているタスクモード。詳細については、「[Choosing a task mode for your data transfer](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)」を参照してください。型: 文字列有効な値：`BASIC | ENHANCED` ** [TaskReportConfig](#API_DescribeTask_ResponseSyntax) ** DataSync 転送に関する詳細情報を提供するタスクレポートの設定。詳細については、「[Monitoring your DataSync transfers with task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)」を参照してください。タイプ: [TaskReportConfig](API_TaskReportConfig.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** InternalException ** この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。 HTTP ステータスコード: 500 ** InvalidRequestException ** この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。 HTTP ステータスコード: 400 ## 例 ### リクエスト例次の例では、情報を取得する DataSync タスクの ARN を指定します。 ``` { "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026" } ``` ### レスポンス例以下は `DescribeTask` レスポンスの例です。 ``` { "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026", "Name": "MyTask", "TaskMode": "BASIC", "Status": "RUNNING", "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3", "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2", "CurrentTaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f", "CreationTime": 1532660733.39, "Options": { "Atime": "BEST_EFFORT", "BytesPerSecond": 1000, "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDevices": "NONE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group:/log-group-name:*" } ``` ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeTask)