Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . datasync ]

update-task

Description

Updates the metadata associated with a task.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-task
--task-arn <value>
[--options <value>]
[--excludes <value>]
[--name <value>]
[--cloud-watch-log-group-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--task-arn (string)

The Amazon Resource Name (ARN) of the resource name of the task to update.

--options (structure)

Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.

A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution , the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution .

Shorthand Syntax:

VerifyMode=string,Atime=string,Mtime=string,Uid=string,Gid=string,PreserveDeletedFiles=string,PreserveDevices=string,PosixPermissions=string,BytesPerSecond=long

JSON Syntax:

{
  "VerifyMode": "POINT_IN_TIME_CONSISTENT"|"NONE",
  "Atime": "NONE"|"BEST_EFFORT",
  "Mtime": "NONE"|"PRESERVE",
  "Uid": "NONE"|"INT_VALUE"|"NAME"|"BOTH",
  "Gid": "NONE"|"INT_VALUE"|"NAME"|"BOTH",
  "PreserveDeletedFiles": "PRESERVE"|"REMOVE",
  "PreserveDevices": "NONE"|"PRESERVE",
  "PosixPermissions": "NONE"|"BEST_EFFORT"|"PRESERVE",
  "BytesPerSecond": long
}

--excludes (list)

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"

Shorthand Syntax:

FilterType=string,Value=string ...

JSON Syntax:

[
  {
    "FilterType": "SIMPLE_PATTERN",
    "Value": "string"
  }
  ...
]

--name (string)

The name of the task to update.

--cloud-watch-log-group-arn (string)

The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output