2023 年 12 月 7 日より、バージョン 1 DataSync のエージェントは廃止されます。 DataSync コンソールの [エージェント] ページをチェックして、影響を受けるエージェントがいないか確認してください。その場合は、データ転送やストレージ検出の中断を避けるため、その前にそれらのエージェントを交換してください。さらにサポートが必要な場合は、お問い合わせくださいAWS Support
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeTask
AWS DataSync転送タスクに関する情報を提供します。
リクエストの構文
{
"TaskArn": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- 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}$必須: はい
レスポンスの構文
{
"CloudWatchLogGroupArn": "string",
"CreationTime": number,
"CurrentTaskExecutionArn": "string",
"DestinationLocationArn": "string",
"DestinationNetworkInterfaceArns": [ "string" ],
"ErrorCode": "string",
"ErrorDetail": "string",
"Excludes": [
{
"FilterType": "string",
"Value": "string"
}
],
"Includes": [
{
"FilterType": "string",
"Value": "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"
},
"SourceLocationArn": "string",
"SourceNetworkInterfaceArns": [ "string" ],
"Status": "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"
}
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- CloudWatchLogGroupArn
-
タスク内のイベントの監視と記録に使用された Amazon CloudWatch ロググループの Amazon リソースネーム (ARN)。
これらのグループの詳細については、Amazon CloudWatch ユーザーガイドの「ロググループとログストリームの操作」を参照してください。
型: 文字列
長さの制限: 最大長は 562 です。
パターン:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$ - CreationTime
-
タスクが作成された時刻。
タイプ: Timestamp
- CurrentTaskExecutionArn
-
ファイルを転送しているタスク実行の 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}/execution/exec-[0-9a-f]{17}$ - DestinationLocationArn
-
AWS ストレージリソースの場所の Amazon リソースネーム (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}$ - DestinationNetworkInterfaceArns
-
宛先ロケーション用に作成されたネットワークインターフェイスの Amazon リソースネーム (ARN)。詳細については、「ネットワークインターフェイス要件」を参照してください。
型: 文字列の配列
長さの制限: 最大長は 128 です。
パターン:
^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$ - ErrorCode
-
タスクの実行中に AWS DataSync で発生したエラー。このエラーコードを使用すると、問題のトラブルシューティングに役立ちます。
型: 文字列
- ErrorDetail
-
タスクの実行中に発生したエラーの詳細な説明。この情報は、問題のトラブルシューティングに役立てることができます。
型: 文字列
- Excludes
-
転送中に特定のデータを除外するフィルタルールのリスト。詳細と例については、「によって転送されたデータのフィルタリング」を参照してください DataSync。
型: FilterRule オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
- Includes
-
転送中に特定のデータを含むフィルタールールのリスト。詳細と例については、「によって転送されるデータのフィルタリング」を参照してください DataSync。
型: FilterRule オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
- Name
-
説明されたタスクの名前。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 256 です。
パターン:
^[a-zA-Z0-9\s+=._:@/-]+$ - Options
-
StartTaskExecution操作の動作を制御する設定オプション。オプションには、ファイルまたはオブジェクトのメタデータの保存やデータの整合性の検証などがあります。これらのオプションはタスクを実行するたびにオーバーライドできます。詳細については、を参照してくださいStartTaskExecution。
型: Options オブジェクト
- Schedule
-
ソースから転送先へのファイルの定期的な転送に使用するスケジュール。
型: TaskSchedule オブジェクト
- SourceLocationArn
-
ソースファイルシステムの場所の Amazon リソースネーム (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}$ - SourceNetworkInterfaceArns
-
ソースロケーション用に作成されたネットワークインターフェイスの Amazon リソースネーム (ARN)。詳細については、「ネットワークインターフェイス要件」を参照してください。
型: 文字列の配列
長さの制限: 最大長は 128 です。
パターン:
^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$ - Status
-
説明されたタスクのステータス。
タスク実行ステータスの詳細については、 AWS DataSync ユーザーガイドの「Understanding Task Statuses」を参照してください。
タイプ: 文字列
有効な値:
AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE - 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
-
タスクレポートの設定。詳細については、「タスクレポートの作成」を参照してください。
型: TaskReportConfig オブジェクト
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalException
-
この例外は、AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
例
例
次の例では、サンプルリクエストで指定されたタスクに関する情報を返します。
リクエスト例
{
"TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}例
この例は、の 1 つの使用法を示しています DescribeTask。
レスポンス例
{
"CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group"
"CreationTime": 1532660733.39,
"CurrentTaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f",
"Options": {
"Atime": "BEST_EFFORT",
"BytesPerSecond": 1000,
"Gid": "NONE",
"Mtime": "PRESERVE",
"PosixPermissions": "PRESERVE",
"PreserveDevices": "NONE",
"PreserveDeletedFiles": "PRESERVE",
"Uid": "NONE",
"VerifyMode": "POINT_IN_TIME_CONSISTENT"
},
"DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50fb",
"ErrorCode": "???????",
"ErrorDetail": "??????",
"Name": "MyTask",
"SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa",
"Status": "CREATING",
"TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
