datasync/aws.sdk.kotlin.services.datasync

Package-level declarations

Types

DataSync is an online data movement and discovery service that simplifies data migration and helps you quickly, easily, and securely transfer your file or object data to, from, and between Amazon Web Services storage services.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

addStorageSystem

inline suspend fun DataSyncClient.addStorageSystem(crossinline block: AddStorageSystemRequest.Builder.() -> Unit): AddStorageSystemResponse

Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.

cancelTaskExecution

inline suspend fun DataSyncClient.cancelTaskExecution(crossinline block: CancelTaskExecutionRequest.Builder.() -> Unit): CancelTaskExecutionResponse

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.

createAgent

inline suspend fun DataSyncClient.createAgent(crossinline block: CreateAgentRequest.Builder.() -> Unit): CreateAgentResponse

Activates an DataSync agent that you've deployed in your storage environment. The activation process associates the agent with your Amazon Web Services account.

createLocationAzureBlob

inline suspend fun DataSyncClient.createLocationAzureBlob(crossinline block: CreateLocationAzureBlobRequest.Builder.() -> Unit): CreateLocationAzureBlobResponse

Creates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location as a transfer source or destination.

createLocationEfs

inline suspend fun DataSyncClient.createLocationEfs(crossinline block: CreateLocationEfsRequest.Builder.() -> Unit): CreateLocationEfsResponse

Creates a transfer location for an Amazon EFS file system. DataSync can use this location as a source or destination for transferring data.

createLocationFsxLustre

inline suspend fun DataSyncClient.createLocationFsxLustre(crossinline block: CreateLocationFsxLustreRequest.Builder.() -> Unit): CreateLocationFsxLustreResponse

Creates a transfer location for an Amazon FSx for Lustre file system. DataSync can use this location as a source or destination for transferring data.

createLocationFsxOntap

inline suspend fun DataSyncClient.createLocationFsxOntap(crossinline block: CreateLocationFsxOntapRequest.Builder.() -> Unit): CreateLocationFsxOntapResponse

Creates a transfer location for an Amazon FSx for NetApp ONTAP file system. DataSync can use this location as a source or destination for transferring data.

createLocationFsxOpenZfs

inline suspend fun DataSyncClient.createLocationFsxOpenZfs(crossinline block: CreateLocationFsxOpenZfsRequest.Builder.() -> Unit): CreateLocationFsxOpenZfsResponse

Creates a transfer location for an Amazon FSx for OpenZFS file system. DataSync can use this location as a source or destination for transferring data.

createLocationFsxWindows

inline suspend fun DataSyncClient.createLocationFsxWindows(crossinline block: CreateLocationFsxWindowsRequest.Builder.() -> Unit): CreateLocationFsxWindowsResponse

Creates a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data.

createLocationHdfs

inline suspend fun DataSyncClient.createLocationHdfs(crossinline block: CreateLocationHdfsRequest.Builder.() -> Unit): CreateLocationHdfsResponse

Creates a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data.

createLocationNfs

inline suspend fun DataSyncClient.createLocationNfs(crossinline block: CreateLocationNfsRequest.Builder.() -> Unit): CreateLocationNfsResponse

Creates a transfer location for a Network File System (NFS) file server. DataSync can use this location as a source or destination for transferring data.

createLocationObjectStorage

inline suspend fun DataSyncClient.createLocationObjectStorage(crossinline block: CreateLocationObjectStorageRequest.Builder.() -> Unit): CreateLocationObjectStorageResponse

Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data.

createLocationS3

inline suspend fun DataSyncClient.createLocationS3(crossinline block: CreateLocationS3Request.Builder.() -> Unit): CreateLocationS3Response

Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring data.

createLocationSmb

inline suspend fun DataSyncClient.createLocationSmb(crossinline block: CreateLocationSmbRequest.Builder.() -> Unit): CreateLocationSmbResponse

Creates a transfer location for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data.

createTask

inline suspend fun DataSyncClient.createTask(crossinline block: CreateTaskRequest.Builder.() -> Unit): CreateTaskResponse

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

deleteAgent

inline suspend fun DataSyncClient.deleteAgent(crossinline block: DeleteAgentRequest.Builder.() -> Unit): DeleteAgentResponse

Removes an DataSync agent resource from your Amazon Web Services account.

deleteLocation

inline suspend fun DataSyncClient.deleteLocation(crossinline block: DeleteLocationRequest.Builder.() -> Unit): DeleteLocationResponse

Deletes a transfer location resource from DataSync.

deleteTask

inline suspend fun DataSyncClient.deleteTask(crossinline block: DeleteTaskRequest.Builder.() -> Unit): DeleteTaskResponse

Deletes a transfer task resource from DataSync.

describeAgent

inline suspend fun DataSyncClient.describeAgent(crossinline block: DescribeAgentRequest.Builder.() -> Unit): DescribeAgentResponse

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

describeDiscoveryJob

inline suspend fun DataSyncClient.describeDiscoveryJob(crossinline block: DescribeDiscoveryJobRequest.Builder.() -> Unit): DescribeDiscoveryJobResponse

Returns information about a DataSync discovery job.

describeLocationAzureBlob

inline suspend fun DataSyncClient.describeLocationAzureBlob(crossinline block: DescribeLocationAzureBlobRequest.Builder.() -> Unit): DescribeLocationAzureBlobResponse

Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.

describeLocationEfs

inline suspend fun DataSyncClient.describeLocationEfs(crossinline block: DescribeLocationEfsRequest.Builder.() -> Unit): DescribeLocationEfsResponse

Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.

describeLocationFsxLustre

inline suspend fun DataSyncClient.describeLocationFsxLustre(crossinline block: DescribeLocationFsxLustreRequest.Builder.() -> Unit): DescribeLocationFsxLustreResponse

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

describeLocationFsxOntap

inline suspend fun DataSyncClient.describeLocationFsxOntap(crossinline block: DescribeLocationFsxOntapRequest.Builder.() -> Unit): DescribeLocationFsxOntapResponse

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

describeLocationFsxOpenZfs

inline suspend fun DataSyncClient.describeLocationFsxOpenZfs(crossinline block: DescribeLocationFsxOpenZfsRequest.Builder.() -> Unit): DescribeLocationFsxOpenZfsResponse

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

describeLocationFsxWindows

inline suspend fun DataSyncClient.describeLocationFsxWindows(crossinline block: DescribeLocationFsxWindowsRequest.Builder.() -> Unit): DescribeLocationFsxWindowsResponse

Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.

describeLocationHdfs

inline suspend fun DataSyncClient.describeLocationHdfs(crossinline block: DescribeLocationHdfsRequest.Builder.() -> Unit): DescribeLocationHdfsResponse

Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.

describeLocationNfs

inline suspend fun DataSyncClient.describeLocationNfs(crossinline block: DescribeLocationNfsRequest.Builder.() -> Unit): DescribeLocationNfsResponse

Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.

describeLocationObjectStorage

inline suspend fun DataSyncClient.describeLocationObjectStorage(crossinline block: DescribeLocationObjectStorageRequest.Builder.() -> Unit): DescribeLocationObjectStorageResponse

Provides details about how an DataSync transfer location for an object storage system is configured.

describeLocationS3

inline suspend fun DataSyncClient.describeLocationS3(crossinline block: DescribeLocationS3Request.Builder.() -> Unit): DescribeLocationS3Response

Provides details about how an DataSync transfer location for an S3 bucket is configured.

describeLocationSmb

inline suspend fun DataSyncClient.describeLocationSmb(crossinline block: DescribeLocationSmbRequest.Builder.() -> Unit): DescribeLocationSmbResponse

Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.

describeStorageSystem

inline suspend fun DataSyncClient.describeStorageSystem(crossinline block: DescribeStorageSystemRequest.Builder.() -> Unit): DescribeStorageSystemResponse

Returns information about an on-premises storage system that you're using with DataSync Discovery.

describeStorageSystemResourceMetrics

inline suspend fun DataSyncClient.describeStorageSystemResourceMetrics(crossinline block: DescribeStorageSystemResourceMetricsRequest.Builder.() -> Unit): DescribeStorageSystemResourceMetricsResponse

Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.

describeStorageSystemResources

inline suspend fun DataSyncClient.describeStorageSystemResources(crossinline block: DescribeStorageSystemResourcesRequest.Builder.() -> Unit): DescribeStorageSystemResourcesResponse

Returns information that DataSync Discovery collects about resources in your on-premises storage system.

describeTask

inline suspend fun DataSyncClient.describeTask(crossinline block: DescribeTaskRequest.Builder.() -> Unit): DescribeTaskResponse

Provides information about an DataSync transfer task.

describeTaskExecution

inline suspend fun DataSyncClient.describeTaskExecution(crossinline block: DescribeTaskExecutionRequest.Builder.() -> Unit): DescribeTaskExecutionResponse

Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing transfer or check the results of the transfer.

generateRecommendations

inline suspend fun DataSyncClient.generateRecommendations(crossinline block: GenerateRecommendationsRequest.Builder.() -> Unit): GenerateRecommendationsResponse

Creates recommendations about where to migrate your data to in Amazon Web Services. Recommendations are generated based on information that DataSync Discovery collects about your on-premises storage system's resources. For more information, see Recommendations provided by DataSync Discovery.

listAgents

inline suspend fun DataSyncClient.listAgents(crossinline block: ListAgentsRequest.Builder.() -> Unit): ListAgentsResponse

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

listDiscoveryJobs

inline suspend fun DataSyncClient.listDiscoveryJobs(crossinline block: ListDiscoveryJobsRequest.Builder.() -> Unit): ListDiscoveryJobsResponse

Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you're using DataSync Discovery.

listLocations

inline suspend fun DataSyncClient.listLocations(crossinline block: ListLocationsRequest.Builder.() -> Unit): ListLocationsResponse

Returns a list of source and destination locations.

listStorageSystems

inline suspend fun DataSyncClient.listStorageSystems(crossinline block: ListStorageSystemsRequest.Builder.() -> Unit): ListStorageSystemsResponse

Lists the on-premises storage systems that you're using with DataSync Discovery.

listTagsForResource

inline suspend fun DataSyncClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

listTaskExecutions

inline suspend fun DataSyncClient.listTaskExecutions(crossinline block: ListTaskExecutionsRequest.Builder.() -> Unit): ListTaskExecutionsResponse

Returns a list of executions for an DataSync transfer task.

listTasks

inline suspend fun DataSyncClient.listTasks(crossinline block: ListTasksRequest.Builder.() -> Unit): ListTasksResponse

Returns a list of the DataSync tasks you created.

removeStorageSystem

inline suspend fun DataSyncClient.removeStorageSystem(crossinline block: RemoveStorageSystemRequest.Builder.() -> Unit): RemoveStorageSystemResponse

Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.

startDiscoveryJob

inline suspend fun DataSyncClient.startDiscoveryJob(crossinline block: StartDiscoveryJobRequest.Builder.() -> Unit): StartDiscoveryJobResponse

Runs a DataSync discovery job on your on-premises storage system. If you haven't added the storage system to DataSync Discovery yet, do this first by using the AddStorageSystem operation.

startTaskExecution

inline suspend fun DataSyncClient.startTaskExecution(crossinline block: StartTaskExecutionRequest.Builder.() -> Unit): StartTaskExecutionResponse

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

stopDiscoveryJob

inline suspend fun DataSyncClient.stopDiscoveryJob(crossinline block: StopDiscoveryJobRequest.Builder.() -> Unit): StopDiscoveryJobResponse

Stops a running DataSync discovery job.

tagResource

inline suspend fun DataSyncClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

untagResource

inline suspend fun DataSyncClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from an Amazon Web Services resource.

updateAgent

inline suspend fun DataSyncClient.updateAgent(crossinline block: UpdateAgentRequest.Builder.() -> Unit): UpdateAgentResponse

Updates the name of an DataSync agent.

updateDiscoveryJob

inline suspend fun DataSyncClient.updateDiscoveryJob(crossinline block: UpdateDiscoveryJobRequest.Builder.() -> Unit): UpdateDiscoveryJobResponse

Edits a DataSync discovery job configuration.

updateLocationAzureBlob

inline suspend fun DataSyncClient.updateLocationAzureBlob(crossinline block: UpdateLocationAzureBlobRequest.Builder.() -> Unit): UpdateLocationAzureBlobResponse

Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.

updateLocationHdfs

inline suspend fun DataSyncClient.updateLocationHdfs(crossinline block: UpdateLocationHdfsRequest.Builder.() -> Unit): UpdateLocationHdfsResponse

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

updateLocationNfs

inline suspend fun DataSyncClient.updateLocationNfs(crossinline block: UpdateLocationNfsRequest.Builder.() -> Unit): UpdateLocationNfsResponse

Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.

updateLocationObjectStorage

inline suspend fun DataSyncClient.updateLocationObjectStorage(crossinline block: UpdateLocationObjectStorageRequest.Builder.() -> Unit): UpdateLocationObjectStorageResponse

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

inline suspend fun DataSyncClient.updateLocationSmb(crossinline block: UpdateLocationSmbRequest.Builder.() -> Unit): UpdateLocationSmbResponse

Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.

updateStorageSystem

inline suspend fun DataSyncClient.updateStorageSystem(crossinline block: UpdateStorageSystemRequest.Builder.() -> Unit): UpdateStorageSystemResponse

Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.

updateTask

inline suspend fun DataSyncClient.updateTask(crossinline block: UpdateTaskRequest.Builder.() -> Unit): UpdateTaskResponse

Updates the configuration of an DataSync transfer task.

updateTaskExecution

inline suspend fun DataSyncClient.updateTaskExecution(crossinline block: UpdateTaskExecutionRequest.Builder.() -> Unit): UpdateTaskExecutionResponse

Updates the configuration of a running DataSync task execution.

withConfig

fun DataSyncClient.withConfig(block: DataSyncClient.Config.Builder.() -> Unit): DataSyncClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.