UpdateTask - AWS DataSync
リクエストの構文リクエストパラメータレスポンス要素エラー以下の資料も参照してください。

2023 年 12 月 7 日より、バージョン 1 DataSync のエージェントは廃止されます。 DataSync コンソールの [エージェント] ページをチェックして、影響を受けるエージェントがいないか確認してください。その場合は、データ転送やストレージ検出の中断を避けるため、その前にそれらのエージェントを交換してください。さらにサポートが必要な場合は、お問い合わせくださいAWS サポート。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

UpdateTask

AWS DataSync転送タスクの設定を更新します。

リクエストの構文

{
   "CloudWatchLogGroupArn": "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"
   },
   "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 形式のデータを受け入れます。

CloudWatchLogGroupArn

Amazon CloudWatch ロググループのリソース名の Amazon リソースネーム (ARN)。

型: 文字列

長さの制限: 最大長は 562 です。

パターン: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$

必須: いいえ

Excludes

転送中に特定のデータを除外するフィルタルールのリストを指定します。詳細と例については、「 DataSyncによって転送されるデータのフィルタリング」を参照してください。

型: FilterRule オブジェクトの配列

配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。

必須: いいえ

Includes

転送中に特定のデータを含めるフィルタルールのリストを指定します。詳細と例については、「によって転送されるデータのフィルタリング」を参照してください DataSync。

型: FilterRule オブジェクトの配列

配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。

必須: いいえ

Name

更新するタスクの名前。

型: 文字列

長さの制限: 最小長は 1 です。最大長は 256 です。

パターン: ^[a-zA-Z0-9\s+=._:@/-]+$

必須: いいえ

Options

転送タスクがどのように構成されているかを示します。これらのオプションには、転送中のファイル、オブジェクト、 DataSync および関連するメタデータの処理方法が含まれます。また、データの整合性の検証方法や、タスクの帯域幅制限の設定方法なども指定できます。

各オプションにはデフォルト値があります。必要でない限り、タスクを開始する前にこれらのオプションを設定する必要はありません。

型: Options オブジェクト

必須: いいえ

Schedule

ソースから転送先へのファイルの定期的な転送に使用するスケジュールを指定します。毎時、毎日、毎週、または特定の曜日に実行するようにタスクを設定できます。タスクを実行する日または時間のタイミングは、ユーザーがコントロールします。指定する時刻は UTC 時間です。詳細については、「タスクのスケジュール」を参照してください。

型: TaskSchedule オブジェクト

必須: いいえ

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 オブジェクト

必須: いいえ

レスポンス要素

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 応答を返します。

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InternalException

この例外は、AWS DataSync サービスでエラーが発生した場合にスローされます。

HTTP ステータスコード: 500

InvalidRequestException

この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。

HTTP ステータスコード: 400

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。