Expand description
AWS DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3) or Amazon Elastic File System (Amazon EFS).
This API interface reference for AWS DataSync contains documentation for a programming interface that you can use to manage AWS DataSync.
If you’re using the service, you’re probably looking for DataSyncClient and DataSync.
Structs§
- Agent
List Entry Represents a single entry in a list of agents.
AgentListEntryreturns an array that contains a list of agents when the ListAgents operation is called.- Cancel
Task Execution Request CancelTaskExecutionRequest
- Cancel
Task Execution Response - Create
Agent Request CreateAgentRequest
- Create
Agent Response CreateAgentResponse
- Create
Location EfsRequest CreateLocationEfsRequest
- Create
Location EfsResponse CreateLocationEfs
- Create
Location FsxWindows Request - Create
Location FsxWindows Response - Create
Location NfsRequest CreateLocationNfsRequest
- Create
Location NfsResponse CreateLocationNfsResponse
- Create
Location Object Storage Request CreateLocationObjectStorageRequest
- Create
Location Object Storage Response CreateLocationObjectStorageResponse
- Create
Location S3Request CreateLocationS3Request
- Create
Location S3Response CreateLocationS3Response
- Create
Location SmbRequest CreateLocationSmbRequest
- Create
Location SmbResponse CreateLocationSmbResponse
- Create
Task Request CreateTaskRequest
- Create
Task Response CreateTaskResponse
- Data
Sync Client - A client for the DataSync API.
- Delete
Agent Request DeleteAgentRequest
- Delete
Agent Response - Delete
Location Request DeleteLocation
- Delete
Location Response - Delete
Task Request DeleteTask
- Delete
Task Response - Describe
Agent Request DescribeAgent
- Describe
Agent Response DescribeAgentResponse
- Describe
Location EfsRequest DescribeLocationEfsRequest
- Describe
Location EfsResponse DescribeLocationEfsResponse
- Describe
Location FsxWindows Request - Describe
Location FsxWindows Response - Describe
Location NfsRequest DescribeLocationNfsRequest
- Describe
Location NfsResponse DescribeLocationNfsResponse
- Describe
Location Object Storage Request DescribeLocationObjectStorageRequest
- Describe
Location Object Storage Response DescribeLocationObjectStorageResponse
- Describe
Location S3Request DescribeLocationS3Request
- Describe
Location S3Response DescribeLocationS3Response
- Describe
Location SmbRequest DescribeLocationSmbRequest
- Describe
Location SmbResponse DescribeLocationSmbResponse
- Describe
Task Execution Request DescribeTaskExecutionRequest
- Describe
Task Execution Response DescribeTaskExecutionResponse
- Describe
Task Request DescribeTaskRequest
- Describe
Task Response DescribeTaskResponse
- Ec2Config
The subnet and the security group that DataSync uses to access target EFS file system. The subnet must have at least one mount target for that file system. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.
- Filter
Rule Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.
- List
Agents Request ListAgentsRequest
- List
Agents Response ListAgentsResponse
- List
Locations Request ListLocationsRequest
- List
Locations Response ListLocationsResponse
- List
Tags ForResource Request ListTagsForResourceRequest
- List
Tags ForResource Response ListTagsForResourceResponse
- List
Task Executions Request ListTaskExecutions
- List
Task Executions Response ListTaskExecutionsResponse
- List
Tasks Request ListTasksRequest
- List
Tasks Response ListTasksResponse
- Location
Filter You can use API filters to narrow down the list of resources returned by
ListLocations. For example, to retrieve all your Amazon S3 locations, you can useListLocationswith filter nameLocationType S3andOperator Equals.- Location
List Entry Represents a single entry in a list of locations.
LocationListEntryreturns an array that contains a list of locations when the ListLocations operation is called.- NfsMount
Options Represents the mount options that are available for DataSync to access an NFS location.
- OnPrem
Config A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.
- Options
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
Optionsvalue to StartTaskExecution.- Private
Link Config The VPC endpoint, subnet, and security group that an agent uses to access IP addresses in a VPC (Virtual Private Cloud).
- S3Config
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.
For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide.
- SmbMount
Options Represents the mount options that are available for DataSync to access an SMB location.
- Start
Task Execution Request StartTaskExecutionRequest
- Start
Task Execution Response StartTaskExecutionResponse
- TagList
Entry Represents a single entry in a list of AWS resource tags.
TagListEntryreturns an array that contains a list of tasks when the ListTagsForResource operation is called.- TagResource
Request TagResourceRequest
- TagResource
Response - Task
Execution List Entry Represents a single entry in a list of task executions.
TaskExecutionListEntryreturns an array that contains a list of specific invocations of a task when the ListTaskExecutions operation is called.- Task
Execution Result Detail Describes the detailed result of a
TaskExecutionoperation. This result includes the time in milliseconds spent in each phase, the status of the task execution, and the errors encountered.- Task
Filter You can use API filters to narrow down the list of resources returned by
ListTasks. For example, to retrieve all tasks on a source location, you can useListTaskswith filter nameLocationIdandOperator Equalswith the ARN for the location.- Task
List Entry Represents a single entry in a list of tasks.
TaskListEntryreturns an array that contains a list of tasks when the ListTasks operation is called. A task includes the source and destination file systems to sync and the options to use for the tasks.- Task
Schedule Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.
- Untag
Resource Request UntagResourceRequest
- Untag
Resource Response - Update
Agent Request UpdateAgentRequest
- Update
Agent Response - Update
Location NfsRequest - Update
Location NfsResponse - Update
Location Object Storage Request - Update
Location Object Storage Response - Update
Location SmbRequest - Update
Location SmbResponse - Update
Task Execution Request - Update
Task Execution Response - Update
Task Request UpdateTaskResponse
- Update
Task Response
Enums§
- Cancel
Task Execution Error - Errors returned by CancelTaskExecution
- Create
Agent Error - Errors returned by CreateAgent
- Create
Location EfsError - Errors returned by CreateLocationEfs
- Create
Location FsxWindows Error - Errors returned by CreateLocationFsxWindows
- Create
Location NfsError - Errors returned by CreateLocationNfs
- Create
Location Object Storage Error - Errors returned by CreateLocationObjectStorage
- Create
Location S3Error - Errors returned by CreateLocationS3
- Create
Location SmbError - Errors returned by CreateLocationSmb
- Create
Task Error - Errors returned by CreateTask
- Delete
Agent Error - Errors returned by DeleteAgent
- Delete
Location Error - Errors returned by DeleteLocation
- Delete
Task Error - Errors returned by DeleteTask
- Describe
Agent Error - Errors returned by DescribeAgent
- Describe
Location EfsError - Errors returned by DescribeLocationEfs
- Describe
Location FsxWindows Error - Errors returned by DescribeLocationFsxWindows
- Describe
Location NfsError - Errors returned by DescribeLocationNfs
- Describe
Location Object Storage Error - Errors returned by DescribeLocationObjectStorage
- Describe
Location S3Error - Errors returned by DescribeLocationS3
- Describe
Location SmbError - Errors returned by DescribeLocationSmb
- Describe
Task Error - Errors returned by DescribeTask
- Describe
Task Execution Error - Errors returned by DescribeTaskExecution
- List
Agents Error - Errors returned by ListAgents
- List
Locations Error - Errors returned by ListLocations
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Task Executions Error - Errors returned by ListTaskExecutions
- List
Tasks Error - Errors returned by ListTasks
- Start
Task Execution Error - Errors returned by StartTaskExecution
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Agent Error - Errors returned by UpdateAgent
- Update
Location NfsError - Errors returned by UpdateLocationNfs
- Update
Location Object Storage Error - Errors returned by UpdateLocationObjectStorage
- Update
Location SmbError - Errors returned by UpdateLocationSmb
- Update
Task Error - Errors returned by UpdateTask
- Update
Task Execution Error - Errors returned by UpdateTaskExecution
Traits§
- Data
Sync - Trait representing the capabilities of the DataSync API. DataSync clients implement this trait.