2019/11/20 - AWS DataSync - 5 updated api methods
Changes Update datasync client to latest version
{'Schedule': {'ScheduleExpression': 'string'}}
Creates a task. A task is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don't specify Options when you create a task, AWS DataSync populates them with service defaults.
When you create a task, it first enters the CREATING state. During CREATING AWS DataSync attempts to mount the on-premises Network File System (NFS) location. The task transitions to the AVAILABLE state without waiting for the AWS location to become mounted. If required, AWS DataSync mounts the AWS location before each task execution.
If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your agent might be having trouble mounting the source NFS file system. Check the task's ErrorCode and ErrorDetail. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS server host name.
See also: AWS API Documentation
Request Syntax
client.create_task(
SourceLocationArn='string',
DestinationLocationArn='string',
CloudWatchLogGroupArn='string',
Name='string',
Options={
'VerifyMode': 'POINT_IN_TIME_CONSISTENT'|'ONLY_FILES_TRANSFERRED'|'NONE',
'OverwriteMode': 'ALWAYS'|'NEVER',
'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'|'PRESERVE',
'BytesPerSecond': 123,
'TaskQueueing': 'ENABLED'|'DISABLED'
},
Excludes=[
{
'FilterType': 'SIMPLE_PATTERN',
'Value': 'string'
},
],
Schedule={
'ScheduleExpression': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the source location for the task.
string
[REQUIRED]
The Amazon Resource Name (ARN) of an AWS storage resource's location.
string
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.
For more information about how to use CloudWatch Logs with DataSync, see Monitoring Your Task in the AWS DataSync User Guide.
string
The name of a task. This value is a text reference that is used to identify the task in the console.
dict
The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.
For each individual task execution, you can override these options by specifying the OverrideOptions before starting a the task execution. For more information, see the operation.
VerifyMode (string) --
A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.
Default value: POINT_IN_TIME_CONSISTENT.
POINT_IN_TIME_CONSISTENT: Perform verification (recommended).
ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred.
NONE: Skip verification.
OverwriteMode (string) --
A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.
Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.
Atime (string) --
A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.
Default value: BEST_EFFORT.
BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
NONE: Ignore Atime.
Mtime (string) --
A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
Default value: PRESERVE.
PRESERVE: Preserve original Mtime (recommended)
NONE: Ignore Mtime.
Uid (string) --
The user ID (UID) of the file's owner.
Default value: INT_VALUE. This preserves the integer value of the ID.
INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
NONE: Ignore UID and GID.
Gid (string) --
The group ID (GID) of the file's owners.
Default value: INT_VALUE. This preserves the integer value of the ID.
INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
NONE: Ignore UID and GID.
PreserveDeletedFiles (string) --
A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see using-storage-classes in the AWS DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
PreserveDevices (string) --
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
Default value: NONE.
NONE: Ignore special devices (recommended).
PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
PosixPermissions (string) --
A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
BytesPerSecond (integer) --
A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 ( =1024*1024).
TaskQueueing (string) --
A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.
If you use the same agent to run multiple tasks you can enable the tasks to run in series. For more information see queue-task-execution.
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"
(dict) --
Specifies which files, folders and objects to include or exclude when transferring files from source to destination.
FilterType (string) --
The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.
Value (string) --
A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
dict
Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see task-scheduling.
ScheduleExpression (string) -- [REQUIRED]
A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location.
list
The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.
(dict) --
Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.
Key (string) -- [REQUIRED]
The key for an AWS resource tag.
Value (string) --
The value for an AWS resource tag.
dict
Response Syntax
{
'TaskArn': 'string'
}
Response Structure
(dict) --
CreateTaskResponse
TaskArn (string) --
The Amazon Resource Name (ARN) of the task.
{'EndpointType': {'FIPS'}}
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.
See also: AWS API Documentation
Request Syntax
client.describe_agent(
AgentArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the agent to describe.
dict
Response Syntax
{
'AgentArn': 'string',
'Name': 'string',
'Status': 'ONLINE'|'OFFLINE',
'LastConnectionTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'EndpointType': 'PUBLIC'|'PRIVATE_LINK'|'FIPS',
'PrivateLinkConfig': {
'VpcEndpointId': 'string',
'PrivateLinkEndpoint': 'string',
'SubnetArns': [
'string',
],
'SecurityGroupArns': [
'string',
]
}
}
Response Structure
(dict) --
DescribeAgentResponse
AgentArn (string) --
The Amazon Resource Name (ARN) of the agent.
Name (string) --
The name of the agent.
Status (string) --
The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.
LastConnectionTime (datetime) --
The time that the agent last connected to DataSyc.
CreationTime (datetime) --
The time that the agent was activated (that is, created in your account).
EndpointType (string) --
The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public Internet.
PrivateLinkConfig (dict) --
The subnet and the security group that DataSync used to access a VPC endpoint.
VpcEndpointId (string) --
The ID of the VPC endpoint that is configured for an agent. An agent that is configured with a VPC endpoint will not be accessible over the public Internet.
PrivateLinkEndpoint (string) --
The private endpoint that is configured for an agent that has access to IP addresses in a PrivateLink. An agent that is configured with this endpoint will not be accessible over the public Internet.
SubnetArns (list) --
The Amazon Resource Names (ARNs) of the subnets that are configured for an agent activated in a VPC or an agent that has access to a VPC endpoint.
(string) --
SecurityGroupArns (list) --
The Amazon Resource Names (ARNs) of the security groups that are configured for the EC2 resource that hosts an agent activated in a VPC or an agent that has access to a VPC endpoint.
(string) --
{'Schedule': {'ScheduleExpression': 'string'}}
Returns metadata about a task.
See also: AWS API Documentation
Request Syntax
client.describe_task(
TaskArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the task to describe.
dict
Response Syntax
{
'TaskArn': 'string',
'Status': 'AVAILABLE'|'CREATING'|'QUEUED'|'RUNNING'|'UNAVAILABLE',
'Name': 'string',
'CurrentTaskExecutionArn': 'string',
'SourceLocationArn': 'string',
'DestinationLocationArn': 'string',
'CloudWatchLogGroupArn': 'string',
'SourceNetworkInterfaceArns': [
'string',
],
'DestinationNetworkInterfaceArns': [
'string',
],
'Options': {
'VerifyMode': 'POINT_IN_TIME_CONSISTENT'|'ONLY_FILES_TRANSFERRED'|'NONE',
'OverwriteMode': 'ALWAYS'|'NEVER',
'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'|'PRESERVE',
'BytesPerSecond': 123,
'TaskQueueing': 'ENABLED'|'DISABLED'
},
'Excludes': [
{
'FilterType': 'SIMPLE_PATTERN',
'Value': 'string'
},
],
'Schedule': {
'ScheduleExpression': 'string'
},
'ErrorCode': 'string',
'ErrorDetail': 'string',
'CreationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
DescribeTaskResponse
TaskArn (string) --
The Amazon Resource Name (ARN) of the task that was described.
Status (string) --
The status of the task that was described.
For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.
Name (string) --
The name of the task that was described.
CurrentTaskExecutionArn (string) --
The Amazon Resource Name (ARN) of the task execution that is syncing files.
SourceLocationArn (string) --
The Amazon Resource Name (ARN) of the source file system's location.
DestinationLocationArn (string) --
The Amazon Resource Name (ARN) of the AWS storage resource's location.
CloudWatchLogGroupArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.
For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.
SourceNetworkInterfaceArns (list) --
The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was created for your subnet.
(string) --
DestinationNetworkInterfaceArns (list) --
The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that was created for your subnet.
(string) --
Options (dict) --
The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group (GID), file permissions, data integrity verification, and so on.
For each individual task execution, you can override these options by specifying the overriding OverrideOptions value to operation.
VerifyMode (string) --
A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.
Default value: POINT_IN_TIME_CONSISTENT.
POINT_IN_TIME_CONSISTENT: Perform verification (recommended).
ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred.
NONE: Skip verification.
OverwriteMode (string) --
A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.
Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.
Atime (string) --
A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.
Default value: BEST_EFFORT.
BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
NONE: Ignore Atime.
Mtime (string) --
A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
Default value: PRESERVE.
PRESERVE: Preserve original Mtime (recommended)
NONE: Ignore Mtime.
Uid (string) --
The user ID (UID) of the file's owner.
Default value: INT_VALUE. This preserves the integer value of the ID.
INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
NONE: Ignore UID and GID.
Gid (string) --
The group ID (GID) of the file's owners.
Default value: INT_VALUE. This preserves the integer value of the ID.
INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
NONE: Ignore UID and GID.
PreserveDeletedFiles (string) --
A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see using-storage-classes in the AWS DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
PreserveDevices (string) --
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
Default value: NONE.
NONE: Ignore special devices (recommended).
PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
PosixPermissions (string) --
A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
BytesPerSecond (integer) --
A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 ( =1024*1024).
TaskQueueing (string) --
A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.
If you use the same agent to run multiple tasks you can enable the tasks to run in series. For more information see queue-task-execution.
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"
(dict) --
Specifies which files, folders and objects to include or exclude when transferring files from source to destination.
FilterType (string) --
The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.
Value (string) --
A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
Schedule (dict) --
The schedule used to periodically transfer files from a source to a destination location.
ScheduleExpression (string) --
A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location.
ErrorCode (string) --
Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
ErrorDetail (string) --
Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.
CreationTime (datetime) --
The time that the task was created.
{'Result': {'TotalDuration': 'long'}}
Returns detailed metadata about a task that is being executed.
See also: AWS API Documentation
Request Syntax
client.describe_task_execution(
TaskExecutionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the task that is being executed.
dict
Response Syntax
{
'TaskExecutionArn': 'string',
'Status': 'QUEUED'|'LAUNCHING'|'PREPARING'|'TRANSFERRING'|'VERIFYING'|'SUCCESS'|'ERROR',
'Options': {
'VerifyMode': 'POINT_IN_TIME_CONSISTENT'|'ONLY_FILES_TRANSFERRED'|'NONE',
'OverwriteMode': 'ALWAYS'|'NEVER',
'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'|'PRESERVE',
'BytesPerSecond': 123,
'TaskQueueing': 'ENABLED'|'DISABLED'
},
'Excludes': [
{
'FilterType': 'SIMPLE_PATTERN',
'Value': 'string'
},
],
'Includes': [
{
'FilterType': 'SIMPLE_PATTERN',
'Value': 'string'
},
],
'StartTime': datetime(2015, 1, 1),
'EstimatedFilesToTransfer': 123,
'EstimatedBytesToTransfer': 123,
'FilesTransferred': 123,
'BytesWritten': 123,
'BytesTransferred': 123,
'Result': {
'PrepareDuration': 123,
'PrepareStatus': 'PENDING'|'SUCCESS'|'ERROR',
'TotalDuration': 123,
'TransferDuration': 123,
'TransferStatus': 'PENDING'|'SUCCESS'|'ERROR',
'VerifyDuration': 123,
'VerifyStatus': 'PENDING'|'SUCCESS'|'ERROR',
'ErrorCode': 'string',
'ErrorDetail': 'string'
}
}
Response Structure
(dict) --
DescribeTaskExecutionResponse
TaskExecutionArn (string) --
The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.
For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.
Status (string) --
The status of the task execution.
For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.
Options (dict) --
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.
VerifyMode (string) --
A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.
Default value: POINT_IN_TIME_CONSISTENT.
POINT_IN_TIME_CONSISTENT: Perform verification (recommended).
ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred.
NONE: Skip verification.
OverwriteMode (string) --
A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.
Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.
Atime (string) --
A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.
Default value: BEST_EFFORT.
BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
NONE: Ignore Atime.
Mtime (string) --
A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
Default value: PRESERVE.
PRESERVE: Preserve original Mtime (recommended)
NONE: Ignore Mtime.
Uid (string) --
The user ID (UID) of the file's owner.
Default value: INT_VALUE. This preserves the integer value of the ID.
INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
NONE: Ignore UID and GID.
Gid (string) --
The group ID (GID) of the file's owners.
Default value: INT_VALUE. This preserves the integer value of the ID.
INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
NONE: Ignore UID and GID.
PreserveDeletedFiles (string) --
A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see using-storage-classes in the AWS DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
PreserveDevices (string) --
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
Default value: NONE.
NONE: Ignore special devices (recommended).
PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
PosixPermissions (string) --
A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
BytesPerSecond (integer) --
A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 ( =1024*1024).
TaskQueueing (string) --
A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.
If you use the same agent to run multiple tasks you can enable the tasks to run in series. For more information see queue-task-execution.
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"
(dict) --
Specifies which files, folders and objects to include or exclude when transferring files from source to destination.
FilterType (string) --
The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.
Value (string) --
A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
Includes (list) --
A list of filter rules that determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"
(dict) --
Specifies which files, folders and objects to include or exclude when transferring files from source to destination.
FilterType (string) --
The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.
Value (string) --
A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
StartTime (datetime) --
The time that the task execution was started.
EstimatedFilesToTransfer (integer) --
The expected number of files that is to be transferred over the network. This value is calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the expected number of files to be transferred. It's calculated based on comparing the content of the source and destination locations and finding the delta that needs to be transferred.
EstimatedBytesToTransfer (integer) --
The estimated physical number of bytes that is to be transferred over the network.
FilesTransferred (integer) --
The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated periodically when each file is read from the source and sent over the network.
If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer. This value can also be greater than EstimatedFilesTransferred in some cases. This element is implementation-specific for some location types, so don't use it as an indicator for a correct file number or to monitor your task execution.
BytesWritten (integer) --
The number of logical bytes written to the destination AWS storage resource.
BytesTransferred (integer) --
The physical number of bytes transferred over the network.
Result (dict) --
The result of the task execution.
PrepareDuration (integer) --
The total time in milliseconds that AWS DataSync spent in the PREPARING phase.
PrepareStatus (string) --
The status of the PREPARING phase.
TotalDuration (integer) --
The total time in milliseconds that AWS DataSync took to transfer the file from the source to the destination location.
TransferDuration (integer) --
The total time in milliseconds that AWS DataSync spent in the TRANSFERRING phase.
TransferStatus (string) --
The status of the TRANSFERRING Phase.
VerifyDuration (integer) --
The total time in milliseconds that AWS DataSync spent in the VERIFYING phase.
VerifyStatus (string) --
The status of the VERIFYING Phase.
ErrorCode (string) --
Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
ErrorDetail (string) --
Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.
{'Schedule': {'ScheduleExpression': 'string'}}
Updates the metadata associated with a task.
See also: AWS API Documentation
Request Syntax
client.update_task(
TaskArn='string',
Options={
'VerifyMode': 'POINT_IN_TIME_CONSISTENT'|'ONLY_FILES_TRANSFERRED'|'NONE',
'OverwriteMode': 'ALWAYS'|'NEVER',
'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'|'PRESERVE',
'BytesPerSecond': 123,
'TaskQueueing': 'ENABLED'|'DISABLED'
},
Excludes=[
{
'FilterType': 'SIMPLE_PATTERN',
'Value': 'string'
},
],
Schedule={
'ScheduleExpression': 'string'
},
Name='string',
CloudWatchLogGroupArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource name of the task to update.
dict
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.
VerifyMode (string) --
A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.
Default value: POINT_IN_TIME_CONSISTENT.
POINT_IN_TIME_CONSISTENT: Perform verification (recommended).
ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred.
NONE: Skip verification.
OverwriteMode (string) --
A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.
Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.
Atime (string) --
A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.
Default value: BEST_EFFORT.
BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
NONE: Ignore Atime.
Mtime (string) --
A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
Default value: PRESERVE.
PRESERVE: Preserve original Mtime (recommended)
NONE: Ignore Mtime.
Uid (string) --
The user ID (UID) of the file's owner.
Default value: INT_VALUE. This preserves the integer value of the ID.
INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
NONE: Ignore UID and GID.
Gid (string) --
The group ID (GID) of the file's owners.
Default value: INT_VALUE. This preserves the integer value of the ID.
INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
NONE: Ignore UID and GID.
PreserveDeletedFiles (string) --
A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see using-storage-classes in the AWS DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
PreserveDevices (string) --
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
Default value: NONE.
NONE: Ignore special devices (recommended).
PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
PosixPermissions (string) --
A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
BytesPerSecond (integer) --
A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 ( =1024*1024).
TaskQueueing (string) --
A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.
If you use the same agent to run multiple tasks you can enable the tasks to run in series. For more information see queue-task-execution.
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"
(dict) --
Specifies which files, folders and objects to include or exclude when transferring files from source to destination.
FilterType (string) --
The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.
Value (string) --
A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
dict
Specifies a schedule used to periodically transfer files from a source to a destination location. You can configure your task to execute hourly, daily, weekly or on specific days of the week. You control when in the day or hour you want the task to execute. The time you specify is UTC time. For more information, see task-scheduling.
ScheduleExpression (string) -- [REQUIRED]
A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location.
string
The name of the task to update.
string
The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup.
dict
Response Syntax
{}
Response Structure
(dict) --