2023 年 12 月 7 日より、バージョン 1 DataSync のエージェントは廃止されます。 DataSync コンソールの [エージェント] ページをチェックして、影響を受けるエージェントがいないか確認してください。その場合は、データ転送やストレージ検出の中断を避けるため、その前にそれらのエージェントを交換してください。さらにサポートが必要な場合は、お問い合わせくださいAWS サポート
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
AWS DataSyncデータを移動する場所と方法を定義する転送タスクを設定します。
タスクには、転送元の場所、転送先の場所、およびデータを転送する方法とタイミングに関するオプション (帯域幅制限、スケジュールなど) が含まれます。
重要
Amazon S3 ロケーションとの間でデータを転送する予定がある場合は、開始する前に S3 DataSync DataSync リクエスト料金と料金ページにどのような影響があるかを確認してください
リクエストの構文
{
"CloudWatchLogGroupArn": "string",
"DestinationLocationArn": "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",
"Tags": [
{
"Key": "string",
"Value": "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 形式のデータを受け入れます。
- CloudWatchLogGroupArn
-
タスク内のイベントの監視と記録に使用される Amazon CloudWatch ロググループの Amazon リソースネーム (ARN)。
CloudWatch でログを使用する方法の詳細については DataSync、『AWS DataSyncユーザーガイド』の「タスクのモニタリング」を参照してください。
これらのグループの詳細については、Amazon CloudWatch Logs ユーザーガイドの「ロググループとログストリームの操作」を参照してください。
型: 文字列
長さの制限: 最大長は 562 です。
パターン:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$必須: いいえ
- 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}$必須: はい
- Excludes
-
転送中に特定のデータを除外するフィルタルールのリストを指定します。詳細と例については、「によって転送されるデータのフィルタリング」を参照してください DataSync。
型: FilterRule オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
必須: いいえ
- Includes
-
転送中に特定のデータを含めるフィルタルールのリストを指定します。詳細と例については、「によって転送されるデータのフィルタリング」を参照してください DataSync。
型: FilterRule オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
必須: いいえ
- Name
-
タスクの名前。この値は、コンソールでタスクを識別するために使用されるテキスト参照です。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 256 です。
パターン:
^[a-zA-Z0-9\s+=._:@/-]+$必須: いいえ
- Options
-
タスクの設定オプションを指定します。オプションには、ファイルまたはオブジェクトのメタデータの保存やデータの整合性の検証などがあります。
タスクを個別に実行 (タスク実行とも呼ばれます) を開始する前に、これらのオプションをオーバーライドすることもできます。詳細については、を参照してくださいStartTaskExecution。
型: Options オブジェクト
必須: いいえ
- Schedule
-
ソースから転送先へのファイルの定期的な転送に使用するスケジュールを指定します。スケジュールは UTC 時間で指定する必要があります。詳細については、「タスクのスケジュール」を参照してください。
型: 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}$必須: はい
- Tags
-
タスクを表す Amazon リソースネーム (ARN) に適用するタグを指定します。
タグはキーと値のペアで、リソースの管理、フィルタリング、検索に役立ちます DataSync 。
型: TagListEntry オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
- TaskReportConfig
-
転送に関する詳細情報を提供するタスクレポートの設定方法を指定します。 DataSync
型: TaskReportConfig オブジェクト
必須: いいえ
レスポンスの構文
{
"TaskArn": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが 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}$
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalException
-
この例外は、AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
例
リクエスト例
次の例では、送信元と送信先の場所を使用してタスクを作成します。
{
"Options": {
"Atime": "BEST_EFFORT",
"Gid": "NONE",
"Mtime": "PRESERVE",
"PosixPermissions": "PRESERVE",
"PreserveDevices": "NONE",
"PreserveDeletedFiles": "PRESERVE",
"Uid": "NONE",
"VerifyMode": "POINT_IN_TIME_CONSISTENT"
},
"Schedule": {
"ScheduleExpression": "0 12 ? * SUN,WED *"
},
"CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group",
"DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50fb",
"Name": "MyTask",
"SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0f01451b140b2af49",
"Tags": [{
"Key": "Name",
"Value": "Task-1"
}]
}レスポンス例
次の応答は、タスクの Amazon リソースネーム (ARN) を返します。
{
"TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
