Struct DataSyncClient

pub struct DataSyncClient { /* private fields */ }

A client for the DataSync API.

Implementations

impl DataSyncClient

pub fn new(region: Region) -> DataSyncClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>( request_dispatcher: D, credentials_provider: P, region: Region, ) -> DataSyncClient

where P: ProvideAwsCredentials + Send + Sync + 'static, D: DispatchSignedRequest + Send + Sync + 'static,

pub fn new_with_client(client: Client, region: Region) -> DataSyncClient

Trait Implementations

impl Clone for DataSyncClient

fn clone(&self) -> DataSyncClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DataSync for DataSyncClient

fn cancel_task_execution<'life0, 'async_trait>( &'life0 self, input: CancelTaskExecutionRequest, ) -> Pin<Box<dyn Future<Output = Result<CancelTaskExecutionResponse, RusotoError<CancelTaskExecutionError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Cancels execution of a task.

When you cancel a task execution, the transfer of some files are abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, AWS DataSync successfully complete the transfer when you start the next task execution.

fn create_agent<'life0, 'async_trait>( &'life0 self, input: CreateAgentRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateAgentResponse, RusotoError<CreateAgentError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Activates an AWS DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS Region.

You can activate the agent in a VPC (Virtual private Cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public Internet.

You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.

Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.

fn create_location_efs<'life0, 'async_trait>( &'life0 self, input: CreateLocationEfsRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateLocationEfsResponse, RusotoError<CreateLocationEfsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates an endpoint for an Amazon EFS file system.

fn create_location_fsx_windows<'life0, 'async_trait>( &'life0 self, input: CreateLocationFsxWindowsRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateLocationFsxWindowsResponse, RusotoError<CreateLocationFsxWindowsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates an endpoint for an Amazon FSx for Windows file system.

fn create_location_nfs<'life0, 'async_trait>( &'life0 self, input: CreateLocationNfsRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateLocationNfsResponse, RusotoError<CreateLocationNfsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Defines a file system on a Network File System (NFS) server that can be read from or written to

fn create_location_s3<'life0, 'async_trait>( &'life0 self, input: CreateLocationS3Request, ) -> Pin<Box<dyn Future<Output = Result<CreateLocationS3Response, RusotoError<CreateLocationS3Error>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates an endpoint for an Amazon S3 bucket.

For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.

For more information, see https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location in the AWS DataSync User Guide.

fn create_location_smb<'life0, 'async_trait>( &'life0 self, input: CreateLocationSmbRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateLocationSmbResponse, RusotoError<CreateLocationSmbError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Defines a file system on an Server Message Block (SMB) server that can be read from or written to.

fn create_task<'life0, 'async_trait>( &'life0 self, input: CreateTaskRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateTaskResponse, RusotoError<CreateTaskError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn delete_agent<'life0, 'async_trait>( &'life0 self, input: DeleteAgentRequest, ) -> Pin<Box<dyn Future<Output = Result<DeleteAgentResponse, RusotoError<DeleteAgentError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.

fn delete_location<'life0, 'async_trait>( &'life0 self, input: DeleteLocationRequest, ) -> Pin<Box<dyn Future<Output = Result<DeleteLocationResponse, RusotoError<DeleteLocationError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes the configuration of a location used by AWS DataSync.

fn delete_task<'life0, 'async_trait>( &'life0 self, input: DeleteTaskRequest, ) -> Pin<Box<dyn Future<Output = Result<DeleteTaskResponse, RusotoError<DeleteTaskError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes a task.

fn describe_agent<'life0, 'async_trait>( &'life0 self, input: DescribeAgentRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeAgentResponse, RusotoError<DescribeAgentError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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.

fn describe_location_efs<'life0, 'async_trait>( &'life0 self, input: DescribeLocationEfsRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeLocationEfsResponse, RusotoError<DescribeLocationEfsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns metadata, such as the path information about an Amazon EFS location.

fn describe_location_fsx_windows<'life0, 'async_trait>( &'life0 self, input: DescribeLocationFsxWindowsRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeLocationFsxWindowsResponse, RusotoError<DescribeLocationFsxWindowsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns metadata, such as the path information about an Amazon FSx for Windows location.

fn describe_location_nfs<'life0, 'async_trait>( &'life0 self, input: DescribeLocationNfsRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeLocationNfsResponse, RusotoError<DescribeLocationNfsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns metadata, such as the path information, about a NFS location.

fn describe_location_s3<'life0, 'async_trait>( &'life0 self, input: DescribeLocationS3Request, ) -> Pin<Box<dyn Future<Output = Result<DescribeLocationS3Response, RusotoError<DescribeLocationS3Error>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns metadata, such as bucket name, about an Amazon S3 bucket location.

fn describe_location_smb<'life0, 'async_trait>( &'life0 self, input: DescribeLocationSmbRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeLocationSmbResponse, RusotoError<DescribeLocationSmbError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns metadata, such as the path and user information about a SMB location.

fn describe_task<'life0, 'async_trait>( &'life0 self, input: DescribeTaskRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeTaskResponse, RusotoError<DescribeTaskError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns metadata about a task.

fn describe_task_execution<'life0, 'async_trait>( &'life0 self, input: DescribeTaskExecutionRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeTaskExecutionResponse, RusotoError<DescribeTaskExecutionError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns detailed metadata about a task that is being executed.

fn list_agents<'life0, 'async_trait>( &'life0 self, input: ListAgentsRequest, ) -> Pin<Box<dyn Future<Output = Result<ListAgentsResponse, RusotoError<ListAgentsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).

By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.

If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.

fn list_locations<'life0, 'async_trait>( &'life0 self, input: ListLocationsRequest, ) -> Pin<Box<dyn Future<Output = Result<ListLocationsResponse, RusotoError<ListLocationsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a lists of source and destination locations.

If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.

fn list_tags_for_resource<'life0, 'async_trait>( &'life0 self, input: ListTagsForResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<ListTagsForResourceResponse, RusotoError<ListTagsForResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns all the tags associated with a specified resources.

fn list_task_executions<'life0, 'async_trait>( &'life0 self, input: ListTaskExecutionsRequest, ) -> Pin<Box<dyn Future<Output = Result<ListTaskExecutionsResponse, RusotoError<ListTaskExecutionsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a list of executed tasks.

fn list_tasks<'life0, 'async_trait>( &'life0 self, input: ListTasksRequest, ) -> Pin<Box<dyn Future<Output = Result<ListTasksResponse, RusotoError<ListTasksError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a list of all the tasks.

fn start_task_execution<'life0, 'async_trait>( &'life0 self, input: StartTaskExecutionRequest, ) -> Pin<Box<dyn Future<Output = Result<StartTaskExecutionResponse, RusotoError<StartTaskExecutionError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time.

TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE.

For detailed information, see the Task Execution section in the Components and Terminology topic in the AWS DataSync User Guide.

fn tag_resource<'life0, 'async_trait>( &'life0 self, input: TagResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<TagResourceResponse, RusotoError<TagResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Applies a key-value pair to an AWS resource.

fn untag_resource<'life0, 'async_trait>( &'life0 self, input: UntagResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<UntagResourceResponse, RusotoError<UntagResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Removes a tag from an AWS resource.

fn update_agent<'life0, 'async_trait>( &'life0 self, input: UpdateAgentRequest, ) -> Pin<Box<dyn Future<Output = Result<UpdateAgentResponse, RusotoError<UpdateAgentError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Updates the name of an agent.

fn update_task<'life0, 'async_trait>( &'life0 self, input: UpdateTaskRequest, ) -> Pin<Box<dyn Future<Output = Result<UpdateTaskResponse, RusotoError<UpdateTaskError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Updates the metadata associated with a task.