DataSync

import { DataSync } from "https://aws-api.deno.dev/v0.4/services/datasync.ts?docs=full";

class DataSync {

constructor(apiFactory: client.ApiFactory);

async cancelTaskExecution(params: CancelTaskExecutionRequest, opts?: client.RequestOptions): Promise<void>;

async createAgent(params: CreateAgentRequest, opts?: client.RequestOptions): Promise<CreateAgentResponse>;

async createLocationEfs(params: CreateLocationEfsRequest, opts?: client.RequestOptions): Promise<CreateLocationEfsResponse>;

async createLocationFsxLustre(params: CreateLocationFsxLustreRequest, opts?: client.RequestOptions): Promise<CreateLocationFsxLustreResponse>;

async createLocationFsxOntap(params: CreateLocationFsxOntapRequest, opts?: client.RequestOptions): Promise<CreateLocationFsxOntapResponse>;

async createLocationFsxOpenZfs(params: CreateLocationFsxOpenZfsRequest, opts?: client.RequestOptions): Promise<CreateLocationFsxOpenZfsResponse>;

async createLocationFsxWindows(params: CreateLocationFsxWindowsRequest, opts?: client.RequestOptions): Promise<CreateLocationFsxWindowsResponse>;

async createLocationHdfs(params: CreateLocationHdfsRequest, opts?: client.RequestOptions): Promise<CreateLocationHdfsResponse>;

async createLocationNfs(params: CreateLocationNfsRequest, opts?: client.RequestOptions): Promise<CreateLocationNfsResponse>;

async createLocationObjectStorage(params: CreateLocationObjectStorageRequest, opts?: client.RequestOptions): Promise<CreateLocationObjectStorageResponse>;

async createLocationS3(params: CreateLocationS3Request, opts?: client.RequestOptions): Promise<CreateLocationS3Response>;

async createLocationSmb(params: CreateLocationSmbRequest, opts?: client.RequestOptions): Promise<CreateLocationSmbResponse>;

async createTask(params: CreateTaskRequest, opts?: client.RequestOptions): Promise<CreateTaskResponse>;

async deleteAgent(params: DeleteAgentRequest, opts?: client.RequestOptions): Promise<void>;

async deleteLocation(params: DeleteLocationRequest, opts?: client.RequestOptions): Promise<void>;

async deleteTask(params: DeleteTaskRequest, opts?: client.RequestOptions): Promise<void>;

async describeAgent(params: DescribeAgentRequest, opts?: client.RequestOptions): Promise<DescribeAgentResponse>;

async describeLocationEfs(params: DescribeLocationEfsRequest, opts?: client.RequestOptions): Promise<DescribeLocationEfsResponse>;

async describeLocationFsxLustre(params: DescribeLocationFsxLustreRequest, opts?: client.RequestOptions): Promise<DescribeLocationFsxLustreResponse>;

async describeLocationFsxOntap(params: DescribeLocationFsxOntapRequest, opts?: client.RequestOptions): Promise<DescribeLocationFsxOntapResponse>;

async describeLocationFsxOpenZfs(params: DescribeLocationFsxOpenZfsRequest, opts?: client.RequestOptions): Promise<DescribeLocationFsxOpenZfsResponse>;

async describeLocationFsxWindows(params: DescribeLocationFsxWindowsRequest, opts?: client.RequestOptions): Promise<DescribeLocationFsxWindowsResponse>;

async describeLocationHdfs(params: DescribeLocationHdfsRequest, opts?: client.RequestOptions): Promise<DescribeLocationHdfsResponse>;

async describeLocationNfs(params: DescribeLocationNfsRequest, opts?: client.RequestOptions): Promise<DescribeLocationNfsResponse>;

async describeLocationObjectStorage(params: DescribeLocationObjectStorageRequest, opts?: client.RequestOptions): Promise<DescribeLocationObjectStorageResponse>;

async describeLocationS3(params: DescribeLocationS3Request, opts?: client.RequestOptions): Promise<DescribeLocationS3Response>;

async describeLocationSmb(params: DescribeLocationSmbRequest, opts?: client.RequestOptions): Promise<DescribeLocationSmbResponse>;

async describeTask(params: DescribeTaskRequest, opts?: client.RequestOptions): Promise<DescribeTaskResponse>;

async describeTaskExecution(params: DescribeTaskExecutionRequest, opts?: client.RequestOptions): Promise<DescribeTaskExecutionResponse>;

async listAgents(params?: ListAgentsRequest, opts?: client.RequestOptions): Promise<ListAgentsResponse>;

async listLocations(params?: ListLocationsRequest, opts?: client.RequestOptions): Promise<ListLocationsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listTaskExecutions(params?: ListTaskExecutionsRequest, opts?: client.RequestOptions): Promise<ListTaskExecutionsResponse>;

async listTasks(params?: ListTasksRequest, opts?: client.RequestOptions): Promise<ListTasksResponse>;

async startTaskExecution(params: StartTaskExecutionRequest, opts?: client.RequestOptions): Promise<StartTaskExecutionResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateAgent(params: UpdateAgentRequest, opts?: client.RequestOptions): Promise<void>;

async updateLocationHdfs(params: UpdateLocationHdfsRequest, opts?: client.RequestOptions): Promise<void>;

async updateLocationNfs(params: UpdateLocationNfsRequest, opts?: client.RequestOptions): Promise<void>;

async updateLocationObjectStorage(params: UpdateLocationObjectStorageRequest, opts?: client.RequestOptions): Promise<void>;

async updateLocationSmb(params: UpdateLocationSmbRequest, opts?: client.RequestOptions): Promise<void>;

async updateTask(params: UpdateTaskRequest, opts?: client.RequestOptions): Promise<void>;

async updateTaskExecution(params: UpdateTaskExecutionRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new DataSync(apiFactory: client.ApiFactory)

[src]

§Methods

cancelTaskExecution(params: CancelTaskExecutionRequest, opts?: client.RequestOptions): Promise<void>

[src]

Stops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destination might be incomplete or inconsistent with the source files.

However, if you start a new task execution using the same task and allow it to finish, file content on the destination will be complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task execution.

createAgent(params: CreateAgentRequest, opts?: client.RequestOptions): Promise<CreateAgentResponse>

[src]

Activates an DataSync agent that you have deployed in your storage environment. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services 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 Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.

createLocationEfs(params: CreateLocationEfsRequest, opts?: client.RequestOptions): Promise<CreateLocationEfsResponse>

[src]

Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see Creating a location for Amazon EFS.

createLocationFsxLustre(params: CreateLocationFsxLustreRequest, opts?: client.RequestOptions): Promise<CreateLocationFsxLustreResponse>

[src]

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

createLocationFsxOntap(params: CreateLocationFsxOntapRequest, opts?: client.RequestOptions): Promise<CreateLocationFsxOntapResponse>

[src]

Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for ONTAP.

createLocationFsxOpenZfs(params: CreateLocationFsxOpenZfsRequest, opts?: client.RequestOptions): Promise<CreateLocationFsxOpenZfsResponse>

[src]

Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for OpenZFS.

Note: Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.

createLocationFsxWindows(params: CreateLocationFsxWindowsRequest, opts?: client.RequestOptions): Promise<CreateLocationFsxWindowsResponse>

[src]

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

createLocationHdfs(params: CreateLocationHdfsRequest, opts?: client.RequestOptions): Promise<CreateLocationHdfsResponse>

[src]

Creates an endpoint for a Hadoop Distributed File System (HDFS).

createLocationNfs(params: CreateLocationNfsRequest, opts?: client.RequestOptions): Promise<CreateLocationNfsResponse>

[src]

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

createLocationObjectStorage(params: CreateLocationObjectStorageRequest, opts?: client.RequestOptions): Promise<CreateLocationObjectStorageResponse>

[src]

Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see Creating a location for object storage.

createLocationS3(params: CreateLocationS3Request, opts?: client.RequestOptions): Promise<CreateLocationS3Response>

[src]

Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer. For more information, see Create an Amazon S3 location.

createLocationSmb(params: CreateLocationSmbRequest, opts?: client.RequestOptions): Promise<CreateLocationSmbResponse>

[src]

Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer. For more information, see Creating an SMB location.

createTask(params: CreateTaskRequest, opts?: client.RequestOptions): Promise<CreateTaskResponse>

[src]

Configures a task, which defines where and how DataSync transfers your data.

A task includes a source location, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).

deleteAgent(params: DeleteAgentRequest, opts?: client.RequestOptions): Promise<void>

[src]

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 Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.

deleteLocation(params: DeleteLocationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the configuration of a location used by DataSync.

deleteTask(params: DeleteTaskRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an DataSync task.

describeAgent(params: DescribeAgentRequest, opts?: client.RequestOptions): Promise<DescribeAgentResponse>

[src]

Returns metadata about an DataSync agent, such as its name, endpoint type, and status.

describeLocationEfs(params: DescribeLocationEfsRequest, opts?: client.RequestOptions): Promise<DescribeLocationEfsResponse>

[src]

Returns metadata about your DataSync location for an Amazon EFS file system.

describeLocationFsxLustre(params: DescribeLocationFsxLustreRequest, opts?: client.RequestOptions): Promise<DescribeLocationFsxLustreResponse>

[src]

Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.

describeLocationFsxOntap(params: DescribeLocationFsxOntapRequest, opts?: client.RequestOptions): Promise<DescribeLocationFsxOntapResponse>

[src]

Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.

Note: If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password.

describeLocationFsxOpenZfs(params: DescribeLocationFsxOpenZfsRequest, opts?: client.RequestOptions): Promise<DescribeLocationFsxOpenZfsResponse>

[src]

Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.

Note: Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.

describeLocationFsxWindows(params: DescribeLocationFsxWindowsRequest, opts?: client.RequestOptions): Promise<DescribeLocationFsxWindowsResponse>

[src]

Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.

describeLocationHdfs(params: DescribeLocationHdfsRequest, opts?: client.RequestOptions): Promise<DescribeLocationHdfsResponse>

[src]

Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.

describeLocationNfs(params: DescribeLocationNfsRequest, opts?: client.RequestOptions): Promise<DescribeLocationNfsResponse>

[src]

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

describeLocationObjectStorage(params: DescribeLocationObjectStorageRequest, opts?: client.RequestOptions): Promise<DescribeLocationObjectStorageResponse>

[src]

Returns metadata about your DataSync location for an object storage system.

describeLocationS3(params: DescribeLocationS3Request, opts?: client.RequestOptions): Promise<DescribeLocationS3Response>

[src]

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

describeLocationSmb(params: DescribeLocationSmbRequest, opts?: client.RequestOptions): Promise<DescribeLocationSmbResponse>

[src]

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

describeTask(params: DescribeTaskRequest, opts?: client.RequestOptions): Promise<DescribeTaskResponse>

[src]

Returns metadata about a task.

describeTaskExecution(params: DescribeTaskExecutionRequest, opts?: client.RequestOptions): Promise<DescribeTaskExecutionResponse>

[src]

Returns detailed metadata about a task that is being executed.

listAgents(params?: ListAgentsRequest, opts?: client.RequestOptions): Promise<ListAgentsResponse>

[src]

Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.

With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents.

ListAgents is eventually consistent. This means the result of running the operation might not reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then immediately run ListAgents, that agent might not show up in the list right away. In situations like this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.

listLocations(params?: ListLocationsRequest, opts?: client.RequestOptions): Promise<ListLocationsResponse>

[src]

Returns a list 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.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Returns all the tags associated with an Amazon Web Services resource.

listTaskExecutions(params?: ListTaskExecutionsRequest, opts?: client.RequestOptions): Promise<ListTaskExecutionsResponse>

[src]

Returns a list of executed tasks.

listTasks(params?: ListTasksRequest, opts?: client.RequestOptions): Promise<ListTasksResponse>

[src]

Returns a list of the DataSync tasks you created.

startTaskExecution(params: StartTaskExecutionRequest, opts?: client.RequestOptions): Promise<StartTaskExecutionResponse>

[src]

Starts an DataSync task. For each task, you can only run one task execution at a time.

There are several phases to a task execution. For more information, see Task execution statuses.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Applies a tag to an Amazon Web Services resource. Tags are key-value pairs that can help you manage, filter, and search for your resources.

These include DataSync resources, such as locations, tasks, and task executions.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes tags from an Amazon Web Services resource.

updateAgent(params: UpdateAgentRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the name of an agent.

updateLocationHdfs(params: UpdateLocationHdfsRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.

updateLocationNfs(params: UpdateLocationNfsRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see Creating a location for NFS.

updateLocationObjectStorage(params: UpdateLocationObjectStorageRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates some parameters of an existing object storage location that DataSync accesses for a transfer. For information about creating a self-managed object storage location, see Creating a location for object storage.

updateLocationSmb(params: UpdateLocationSmbRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB.

updateTask(params: UpdateTaskRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the metadata associated with a task.

updateTaskExecution(params: UpdateTaskExecutionRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates execution of a task.

You can modify bandwidth throttling for a task execution that is running or queued. For more information, see Adjusting Bandwidth Throttling for a Task Execution.

Note: The only Option that can be modified by UpdateTaskExecution is [BytesPerSecond](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond).

§Static Properties

ApiMetadata: client.ApiMetadata

[src]