@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface DataSyncAsyncClient extends AwsClient
builder() method.
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.
This API interface reference includes documentation for using DataSync programmatically. For complete information, see the DataSync User Guide .
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AddStorageSystemResponse> |
addStorageSystem(AddStorageSystemRequest addStorageSystemRequest)
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to
collect information about.
|
default CompletableFuture<AddStorageSystemResponse> |
addStorageSystem(Consumer<AddStorageSystemRequest.Builder> addStorageSystemRequest)
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to
collect information about.
|
static DataSyncAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
DataSyncAsyncClient. |
default CompletableFuture<CancelTaskExecutionResponse> |
cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)
Stops an DataSync task execution that's in progress.
|
default CompletableFuture<CancelTaskExecutionResponse> |
cancelTaskExecution(Consumer<CancelTaskExecutionRequest.Builder> cancelTaskExecutionRequest)
Stops an DataSync task execution that's in progress.
|
static DataSyncAsyncClient |
create()
Create a
DataSyncAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateAgentResponse> |
createAgent(Consumer<CreateAgentRequest.Builder> createAgentRequest)
Activates an DataSync agent that you've deployed in your storage environment.
|
default CompletableFuture<CreateAgentResponse> |
createAgent(CreateAgentRequest createAgentRequest)
Activates an DataSync agent that you've deployed in your storage environment.
|
default CompletableFuture<CreateLocationAzureBlobResponse> |
createLocationAzureBlob(Consumer<CreateLocationAzureBlobRequest.Builder> createLocationAzureBlobRequest)
Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or
destination.
|
default CompletableFuture<CreateLocationAzureBlobResponse> |
createLocationAzureBlob(CreateLocationAzureBlobRequest createLocationAzureBlobRequest)
Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or
destination.
|
default CompletableFuture<CreateLocationEfsResponse> |
createLocationEfs(Consumer<CreateLocationEfsRequest.Builder> createLocationEfsRequest)
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer.
|
default CompletableFuture<CreateLocationEfsResponse> |
createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer.
|
default CompletableFuture<CreateLocationFsxLustreResponse> |
createLocationFsxLustre(Consumer<CreateLocationFsxLustreRequest.Builder> createLocationFsxLustreRequest)
Creates an endpoint for an Amazon FSx for Lustre file system.
|
default CompletableFuture<CreateLocationFsxLustreResponse> |
createLocationFsxLustre(CreateLocationFsxLustreRequest createLocationFsxLustreRequest)
Creates an endpoint for an Amazon FSx for Lustre file system.
|
default CompletableFuture<CreateLocationFsxOntapResponse> |
createLocationFsxOntap(Consumer<CreateLocationFsxOntapRequest.Builder> createLocationFsxOntapRequest)
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can use for a data transfer.
|
default CompletableFuture<CreateLocationFsxOntapResponse> |
createLocationFsxOntap(CreateLocationFsxOntapRequest createLocationFsxOntapRequest)
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can use for a data transfer.
|
default CompletableFuture<CreateLocationFsxOpenZfsResponse> |
createLocationFsxOpenZfs(Consumer<CreateLocationFsxOpenZfsRequest.Builder> createLocationFsxOpenZfsRequest)
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer.
|
default CompletableFuture<CreateLocationFsxOpenZfsResponse> |
createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest)
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer.
|
default CompletableFuture<CreateLocationFsxWindowsResponse> |
createLocationFsxWindows(Consumer<CreateLocationFsxWindowsRequest.Builder> createLocationFsxWindowsRequest)
Creates an endpoint for an Amazon FSx for Windows File Server file system that DataSync can use for a data
transfer.
|
default CompletableFuture<CreateLocationFsxWindowsResponse> |
createLocationFsxWindows(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest)
Creates an endpoint for an Amazon FSx for Windows File Server file system that DataSync can use for a data
transfer.
|
default CompletableFuture<CreateLocationHdfsResponse> |
createLocationHdfs(Consumer<CreateLocationHdfsRequest.Builder> createLocationHdfsRequest)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
|
default CompletableFuture<CreateLocationHdfsResponse> |
createLocationHdfs(CreateLocationHdfsRequest createLocationHdfsRequest)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
|
default CompletableFuture<CreateLocationNfsResponse> |
createLocationNfs(Consumer<CreateLocationNfsRequest.Builder> createLocationNfsRequest)
Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.
|
default CompletableFuture<CreateLocationNfsResponse> |
createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)
Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.
|
default CompletableFuture<CreateLocationObjectStorageResponse> |
createLocationObjectStorage(Consumer<CreateLocationObjectStorageRequest.Builder> createLocationObjectStorageRequest)
Creates an endpoint for an object storage system that DataSync can access for a transfer.
|
default CompletableFuture<CreateLocationObjectStorageResponse> |
createLocationObjectStorage(CreateLocationObjectStorageRequest createLocationObjectStorageRequest)
Creates an endpoint for an object storage system that DataSync can access for a transfer.
|
default CompletableFuture<CreateLocationS3Response> |
createLocationS3(Consumer<CreateLocationS3Request.Builder> createLocationS3Request)
A location is an endpoint for an Amazon S3 bucket.
|
default CompletableFuture<CreateLocationS3Response> |
createLocationS3(CreateLocationS3Request createLocationS3Request)
A location is an endpoint for an Amazon S3 bucket.
|
default CompletableFuture<CreateLocationSmbResponse> |
createLocationSmb(Consumer<CreateLocationSmbRequest.Builder> createLocationSmbRequest)
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can use for a data transfer.
|
default CompletableFuture<CreateLocationSmbResponse> |
createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest)
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can use for a data transfer.
|
default CompletableFuture<CreateTaskResponse> |
createTask(Consumer<CreateTaskRequest.Builder> createTaskRequest)
Configures a transfer task, which defines where and how DataSync moves your data.
|
default CompletableFuture<CreateTaskResponse> |
createTask(CreateTaskRequest createTaskRequest)
Configures a transfer task, which defines where and how DataSync moves your data.
|
default CompletableFuture<DeleteAgentResponse> |
deleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest)
Removes an DataSync agent resource from your Amazon Web Services account.
|
default CompletableFuture<DeleteAgentResponse> |
deleteAgent(DeleteAgentRequest deleteAgentRequest)
Removes an DataSync agent resource from your Amazon Web Services account.
|
default CompletableFuture<DeleteLocationResponse> |
deleteLocation(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest)
Deletes the configuration of a location used by DataSync.
|
default CompletableFuture<DeleteLocationResponse> |
deleteLocation(DeleteLocationRequest deleteLocationRequest)
Deletes the configuration of a location used by DataSync.
|
default CompletableFuture<DeleteTaskResponse> |
deleteTask(Consumer<DeleteTaskRequest.Builder> deleteTaskRequest)
Deletes an DataSync transfer task.
|
default CompletableFuture<DeleteTaskResponse> |
deleteTask(DeleteTaskRequest deleteTaskRequest)
Deletes an DataSync transfer task.
|
default CompletableFuture<DescribeAgentResponse> |
describeAgent(Consumer<DescribeAgentRequest.Builder> describeAgentRequest)
Returns information about an DataSync agent, such as its name, service endpoint type, and status.
|
default CompletableFuture<DescribeAgentResponse> |
describeAgent(DescribeAgentRequest describeAgentRequest)
Returns information about an DataSync agent, such as its name, service endpoint type, and status.
|
default CompletableFuture<DescribeDiscoveryJobResponse> |
describeDiscoveryJob(Consumer<DescribeDiscoveryJobRequest.Builder> describeDiscoveryJobRequest)
Returns information about a DataSync discovery job.
|
default CompletableFuture<DescribeDiscoveryJobResponse> |
describeDiscoveryJob(DescribeDiscoveryJobRequest describeDiscoveryJobRequest)
Returns information about a DataSync discovery job.
|
default CompletableFuture<DescribeLocationAzureBlobResponse> |
describeLocationAzureBlob(Consumer<DescribeLocationAzureBlobRequest.Builder> describeLocationAzureBlobRequest)
Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
|
default CompletableFuture<DescribeLocationAzureBlobResponse> |
describeLocationAzureBlob(DescribeLocationAzureBlobRequest describeLocationAzureBlobRequest)
Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
|
default CompletableFuture<DescribeLocationEfsResponse> |
describeLocationEfs(Consumer<DescribeLocationEfsRequest.Builder> describeLocationEfsRequest)
Returns metadata about your DataSync location for an Amazon EFS file system.
|
default CompletableFuture<DescribeLocationEfsResponse> |
describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)
Returns metadata about your DataSync location for an Amazon EFS file system.
|
default CompletableFuture<DescribeLocationFsxLustreResponse> |
describeLocationFsxLustre(Consumer<DescribeLocationFsxLustreRequest.Builder> describeLocationFsxLustreRequest)
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
|
default CompletableFuture<DescribeLocationFsxLustreResponse> |
describeLocationFsxLustre(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest)
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
|
default CompletableFuture<DescribeLocationFsxOntapResponse> |
describeLocationFsxOntap(Consumer<DescribeLocationFsxOntapRequest.Builder> describeLocationFsxOntapRequest)
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
|
default CompletableFuture<DescribeLocationFsxOntapResponse> |
describeLocationFsxOntap(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest)
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
|
default CompletableFuture<DescribeLocationFsxOpenZfsResponse> |
describeLocationFsxOpenZfs(Consumer<DescribeLocationFsxOpenZfsRequest.Builder> describeLocationFsxOpenZfsRequest)
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
|
default CompletableFuture<DescribeLocationFsxOpenZfsResponse> |
describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest)
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
|
default CompletableFuture<DescribeLocationFsxWindowsResponse> |
describeLocationFsxWindows(Consumer<DescribeLocationFsxWindowsRequest.Builder> describeLocationFsxWindowsRequest)
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
|
default CompletableFuture<DescribeLocationFsxWindowsResponse> |
describeLocationFsxWindows(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest)
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
|
default CompletableFuture<DescribeLocationHdfsResponse> |
describeLocationHdfs(Consumer<DescribeLocationHdfsRequest.Builder> describeLocationHdfsRequest)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS)
location.
|
default CompletableFuture<DescribeLocationHdfsResponse> |
describeLocationHdfs(DescribeLocationHdfsRequest describeLocationHdfsRequest)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS)
location.
|
default CompletableFuture<DescribeLocationNfsResponse> |
describeLocationNfs(Consumer<DescribeLocationNfsRequest.Builder> describeLocationNfsRequest)
Provides details about how an DataSync transfer location for a Network File System (NFS) file server is
configured.
|
default CompletableFuture<DescribeLocationNfsResponse> |
describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)
Provides details about how an DataSync transfer location for a Network File System (NFS) file server is
configured.
|
default CompletableFuture<DescribeLocationObjectStorageResponse> |
describeLocationObjectStorage(Consumer<DescribeLocationObjectStorageRequest.Builder> describeLocationObjectStorageRequest)
Returns metadata about your DataSync location for an object storage system.
|
default CompletableFuture<DescribeLocationObjectStorageResponse> |
describeLocationObjectStorage(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest)
Returns metadata about your DataSync location for an object storage system.
|
default CompletableFuture<DescribeLocationS3Response> |
describeLocationS3(Consumer<DescribeLocationS3Request.Builder> describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
|
default CompletableFuture<DescribeLocationS3Response> |
describeLocationS3(DescribeLocationS3Request describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
|
default CompletableFuture<DescribeLocationSmbResponse> |
describeLocationSmb(Consumer<DescribeLocationSmbRequest.Builder> describeLocationSmbRequest)
Returns metadata, such as the path and user information about an SMB location.
|
default CompletableFuture<DescribeLocationSmbResponse> |
describeLocationSmb(DescribeLocationSmbRequest describeLocationSmbRequest)
Returns metadata, such as the path and user information about an SMB location.
|
default CompletableFuture<DescribeStorageSystemResponse> |
describeStorageSystem(Consumer<DescribeStorageSystemRequest.Builder> describeStorageSystemRequest)
Returns information about an on-premises storage system that you're using with DataSync Discovery.
|
default CompletableFuture<DescribeStorageSystemResponse> |
describeStorageSystem(DescribeStorageSystemRequest describeStorageSystemRequest)
Returns information about an on-premises storage system that you're using with DataSync Discovery.
|
default CompletableFuture<DescribeStorageSystemResourceMetricsResponse> |
describeStorageSystemResourceMetrics(Consumer<DescribeStorageSystemResourceMetricsRequest.Builder> describeStorageSystemResourceMetricsRequest)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a
specific resource in your-premises storage system.
|
default CompletableFuture<DescribeStorageSystemResourceMetricsResponse> |
describeStorageSystemResourceMetrics(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a
specific resource in your-premises storage system.
|
default DescribeStorageSystemResourceMetricsPublisher |
describeStorageSystemResourceMetricsPaginator(Consumer<DescribeStorageSystemResourceMetricsRequest.Builder> describeStorageSystemResourceMetricsRequest)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a
specific resource in your-premises storage system.
|
default DescribeStorageSystemResourceMetricsPublisher |
describeStorageSystemResourceMetricsPaginator(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a
specific resource in your-premises storage system.
|
default CompletableFuture<DescribeStorageSystemResourcesResponse> |
describeStorageSystemResources(Consumer<DescribeStorageSystemResourcesRequest.Builder> describeStorageSystemResourcesRequest)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
|
default CompletableFuture<DescribeStorageSystemResourcesResponse> |
describeStorageSystemResources(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
|
default DescribeStorageSystemResourcesPublisher |
describeStorageSystemResourcesPaginator(Consumer<DescribeStorageSystemResourcesRequest.Builder> describeStorageSystemResourcesRequest)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
|
default DescribeStorageSystemResourcesPublisher |
describeStorageSystemResourcesPaginator(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
|
default CompletableFuture<DescribeTaskResponse> |
describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest)
Provides information about an DataSync transfer task.
|
default CompletableFuture<DescribeTaskResponse> |
describeTask(DescribeTaskRequest describeTaskRequest)
Provides information about an DataSync transfer task.
|
default CompletableFuture<DescribeTaskExecutionResponse> |
describeTaskExecution(Consumer<DescribeTaskExecutionRequest.Builder> describeTaskExecutionRequest)
Provides information about an execution of your DataSync task.
|
default CompletableFuture<DescribeTaskExecutionResponse> |
describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)
Provides information about an execution of your DataSync task.
|
default CompletableFuture<GenerateRecommendationsResponse> |
generateRecommendations(Consumer<GenerateRecommendationsRequest.Builder> generateRecommendationsRequest)
Creates recommendations about where to migrate your data to in Amazon Web Services.
|
default CompletableFuture<GenerateRecommendationsResponse> |
generateRecommendations(GenerateRecommendationsRequest generateRecommendationsRequest)
Creates recommendations about where to migrate your data to in Amazon Web Services.
|
default CompletableFuture<ListAgentsResponse> |
listAgents()
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region
specified in the request.
|
default CompletableFuture<ListAgentsResponse> |
listAgents(Consumer<ListAgentsRequest.Builder> listAgentsRequest)
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region
specified in the request.
|
default CompletableFuture<ListAgentsResponse> |
listAgents(ListAgentsRequest listAgentsRequest)
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region
specified in the request.
|
default ListAgentsPublisher |
listAgentsPaginator()
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region
specified in the request.
|
default ListAgentsPublisher |
listAgentsPaginator(Consumer<ListAgentsRequest.Builder> listAgentsRequest)
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region
specified in the request.
|
default ListAgentsPublisher |
listAgentsPaginator(ListAgentsRequest listAgentsRequest)
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region
specified in the request.
|
default CompletableFuture<ListDiscoveryJobsResponse> |
listDiscoveryJobs(Consumer<ListDiscoveryJobsRequest.Builder> listDiscoveryJobsRequest)
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.
|
default CompletableFuture<ListDiscoveryJobsResponse> |
listDiscoveryJobs(ListDiscoveryJobsRequest listDiscoveryJobsRequest)
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.
|
default ListDiscoveryJobsPublisher |
listDiscoveryJobsPaginator(Consumer<ListDiscoveryJobsRequest.Builder> listDiscoveryJobsRequest)
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.
|
default ListDiscoveryJobsPublisher |
listDiscoveryJobsPaginator(ListDiscoveryJobsRequest listDiscoveryJobsRequest)
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.
|
default CompletableFuture<ListLocationsResponse> |
listLocations()
Returns a list of source and destination locations.
|
default CompletableFuture<ListLocationsResponse> |
listLocations(Consumer<ListLocationsRequest.Builder> listLocationsRequest)
Returns a list of source and destination locations.
|
default CompletableFuture<ListLocationsResponse> |
listLocations(ListLocationsRequest listLocationsRequest)
Returns a list of source and destination locations.
|
default ListLocationsPublisher |
listLocationsPaginator()
Returns a list of source and destination locations.
|
default ListLocationsPublisher |
listLocationsPaginator(Consumer<ListLocationsRequest.Builder> listLocationsRequest)
Returns a list of source and destination locations.
|
default ListLocationsPublisher |
listLocationsPaginator(ListLocationsRequest listLocationsRequest)
Returns a list of source and destination locations.
|
default CompletableFuture<ListStorageSystemsResponse> |
listStorageSystems(Consumer<ListStorageSystemsRequest.Builder> listStorageSystemsRequest)
Lists the on-premises storage systems that you're using with DataSync Discovery.
|
default CompletableFuture<ListStorageSystemsResponse> |
listStorageSystems(ListStorageSystemsRequest listStorageSystemsRequest)
Lists the on-premises storage systems that you're using with DataSync Discovery.
|
default ListStorageSystemsPublisher |
listStorageSystemsPaginator(Consumer<ListStorageSystemsRequest.Builder> listStorageSystemsRequest)
Lists the on-premises storage systems that you're using with DataSync Discovery.
|
default ListStorageSystemsPublisher |
listStorageSystemsPaginator(ListStorageSystemsRequest listStorageSystemsRequest)
Lists the on-premises storage systems that you're using with DataSync Discovery.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
|
default CompletableFuture<ListTaskExecutionsResponse> |
listTaskExecutions()
Returns a list of executed tasks.
|
default CompletableFuture<ListTaskExecutionsResponse> |
listTaskExecutions(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)
Returns a list of executed tasks.
|
default CompletableFuture<ListTaskExecutionsResponse> |
listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
|
default ListTaskExecutionsPublisher |
listTaskExecutionsPaginator()
Returns a list of executed tasks.
|
default ListTaskExecutionsPublisher |
listTaskExecutionsPaginator(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)
Returns a list of executed tasks.
|
default ListTaskExecutionsPublisher |
listTaskExecutionsPaginator(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
|
default CompletableFuture<ListTasksResponse> |
listTasks()
Returns a list of the DataSync tasks you created.
|
default CompletableFuture<ListTasksResponse> |
listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of the DataSync tasks you created.
|
default CompletableFuture<ListTasksResponse> |
listTasks(ListTasksRequest listTasksRequest)
Returns a list of the DataSync tasks you created.
|
default ListTasksPublisher |
listTasksPaginator()
Returns a list of the DataSync tasks you created.
|
default ListTasksPublisher |
listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of the DataSync tasks you created.
|
default ListTasksPublisher |
listTasksPaginator(ListTasksRequest listTasksRequest)
Returns a list of the DataSync tasks you created.
|
default CompletableFuture<RemoveStorageSystemResponse> |
removeStorageSystem(Consumer<RemoveStorageSystemRequest.Builder> removeStorageSystemRequest)
Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs,
collected data, and recommendations.
|
default CompletableFuture<RemoveStorageSystemResponse> |
removeStorageSystem(RemoveStorageSystemRequest removeStorageSystemRequest)
Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs,
collected data, and recommendations.
|
default DataSyncServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<StartDiscoveryJobResponse> |
startDiscoveryJob(Consumer<StartDiscoveryJobRequest.Builder> startDiscoveryJobRequest)
Runs a DataSync discovery job on your on-premises storage system.
|
default CompletableFuture<StartDiscoveryJobResponse> |
startDiscoveryJob(StartDiscoveryJobRequest startDiscoveryJobRequest)
Runs a DataSync discovery job on your on-premises storage system.
|
default CompletableFuture<StartTaskExecutionResponse> |
startTaskExecution(Consumer<StartTaskExecutionRequest.Builder> startTaskExecutionRequest)
Starts an DataSync transfer task.
|
default CompletableFuture<StartTaskExecutionResponse> |
startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest)
Starts an DataSync transfer task.
|
default CompletableFuture<StopDiscoveryJobResponse> |
stopDiscoveryJob(Consumer<StopDiscoveryJobRequest.Builder> stopDiscoveryJobRequest)
Stops a running DataSync discovery job.
|
default CompletableFuture<StopDiscoveryJobResponse> |
stopDiscoveryJob(StopDiscoveryJobRequest stopDiscoveryJobRequest)
Stops a running DataSync discovery job.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies a tag to an Amazon Web Services resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Applies a tag to an Amazon Web Services resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
default CompletableFuture<UpdateAgentResponse> |
updateAgent(Consumer<UpdateAgentRequest.Builder> updateAgentRequest)
Updates the name of an DataSync agent.
|
default CompletableFuture<UpdateAgentResponse> |
updateAgent(UpdateAgentRequest updateAgentRequest)
Updates the name of an DataSync agent.
|
default CompletableFuture<UpdateDiscoveryJobResponse> |
updateDiscoveryJob(Consumer<UpdateDiscoveryJobRequest.Builder> updateDiscoveryJobRequest)
Edits a DataSync discovery job configuration.
|
default CompletableFuture<UpdateDiscoveryJobResponse> |
updateDiscoveryJob(UpdateDiscoveryJobRequest updateDiscoveryJobRequest)
Edits a DataSync discovery job configuration.
|
default CompletableFuture<UpdateLocationAzureBlobResponse> |
updateLocationAzureBlob(Consumer<UpdateLocationAzureBlobRequest.Builder> updateLocationAzureBlobRequest)
Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with
DataSync.
|
default CompletableFuture<UpdateLocationAzureBlobResponse> |
updateLocationAzureBlob(UpdateLocationAzureBlobRequest updateLocationAzureBlobRequest)
Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with
DataSync.
|
default CompletableFuture<UpdateLocationHdfsResponse> |
updateLocationHdfs(Consumer<UpdateLocationHdfsRequest.Builder> updateLocationHdfsRequest)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
|
default CompletableFuture<UpdateLocationHdfsResponse> |
updateLocationHdfs(UpdateLocationHdfsRequest updateLocationHdfsRequest)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
|
default CompletableFuture<UpdateLocationNfsResponse> |
updateLocationNfs(Consumer<UpdateLocationNfsRequest.Builder> updateLocationNfsRequest)
Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.
|
default CompletableFuture<UpdateLocationNfsResponse> |
updateLocationNfs(UpdateLocationNfsRequest updateLocationNfsRequest)
Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.
|
default CompletableFuture<UpdateLocationObjectStorageResponse> |
updateLocationObjectStorage(Consumer<UpdateLocationObjectStorageRequest.Builder> updateLocationObjectStorageRequest)
Updates some parameters of an existing object storage location that DataSync accesses for a transfer.
|
default CompletableFuture<UpdateLocationObjectStorageResponse> |
updateLocationObjectStorage(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest)
Updates some parameters of an existing object storage location that DataSync accesses for a transfer.
|
default CompletableFuture<UpdateLocationSmbResponse> |
updateLocationSmb(Consumer<UpdateLocationSmbRequest.Builder> updateLocationSmbRequest)
Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync
transfers.
|
default CompletableFuture<UpdateLocationSmbResponse> |
updateLocationSmb(UpdateLocationSmbRequest updateLocationSmbRequest)
Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync
transfers.
|
default CompletableFuture<UpdateStorageSystemResponse> |
updateStorageSystem(Consumer<UpdateStorageSystemRequest.Builder> updateStorageSystemRequest)
Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
|
default CompletableFuture<UpdateStorageSystemResponse> |
updateStorageSystem(UpdateStorageSystemRequest updateStorageSystemRequest)
Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
|
default CompletableFuture<UpdateTaskResponse> |
updateTask(Consumer<UpdateTaskRequest.Builder> updateTaskRequest)
Updates the configuration of a DataSync transfer task.
|
default CompletableFuture<UpdateTaskResponse> |
updateTask(UpdateTaskRequest updateTaskRequest)
Updates the configuration of a DataSync transfer task.
|
default CompletableFuture<UpdateTaskExecutionResponse> |
updateTaskExecution(Consumer<UpdateTaskExecutionRequest.Builder> updateTaskExecutionRequest)
Updates the configuration of a running DataSync task execution.
|
default CompletableFuture<UpdateTaskExecutionResponse> |
updateTaskExecution(UpdateTaskExecutionRequest updateTaskExecutionRequest)
Updates the configuration of a running DataSync task execution.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<AddStorageSystemResponse> addStorageSystem(AddStorageSystemRequest addStorageSystemRequest)
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
addStorageSystemRequest - default CompletableFuture<AddStorageSystemResponse> addStorageSystem(Consumer<AddStorageSystemRequest.Builder> addStorageSystemRequest)
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
This is a convenience which creates an instance of the AddStorageSystemRequest.Builder avoiding the need
to create one manually via AddStorageSystemRequest.builder()
addStorageSystemRequest - A Consumer that will call methods on
AddStorageSystemRequest.Builder to create a
request.default CompletableFuture<CancelTaskExecutionResponse> cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)
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.
cancelTaskExecutionRequest - CancelTaskExecutionRequestdefault CompletableFuture<CancelTaskExecutionResponse> cancelTaskExecution(Consumer<CancelTaskExecutionRequest.Builder> cancelTaskExecutionRequest)
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.
This is a convenience which creates an instance of the CancelTaskExecutionRequest.Builder avoiding the
need to create one manually via CancelTaskExecutionRequest.builder()
cancelTaskExecutionRequest - A Consumer that will call methods on
CancelTaskExecutionRequest.Builder to create a
request. CancelTaskExecutionRequestdefault CompletableFuture<CreateAgentResponse> createAgent(CreateAgentRequest createAgentRequest)
Activates an DataSync agent that you've deployed in your storage environment. The activation process associates the agent with your Amazon Web Services account.
If you haven't deployed an agent yet, see the following topics to learn more:
If you're transferring between Amazon Web Services storage services, you don't need a DataSync agent.
createAgentRequest - CreateAgentRequestdefault CompletableFuture<CreateAgentResponse> createAgent(Consumer<CreateAgentRequest.Builder> createAgentRequest)
Activates an DataSync agent that you've deployed in your storage environment. The activation process associates the agent with your Amazon Web Services account.
If you haven't deployed an agent yet, see the following topics to learn more:
If you're transferring between Amazon Web Services storage services, you don't need a DataSync agent.
This is a convenience which creates an instance of the CreateAgentRequest.Builder avoiding the need to
create one manually via CreateAgentRequest.builder()
createAgentRequest - A Consumer that will call methods on
CreateAgentRequest.Builder to create a request.
CreateAgentRequestdefault CompletableFuture<CreateLocationAzureBlobResponse> createLocationAzureBlob(CreateLocationAzureBlobRequest createLocationAzureBlobRequest)
Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or destination.
Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your container.
createLocationAzureBlobRequest - default CompletableFuture<CreateLocationAzureBlobResponse> createLocationAzureBlob(Consumer<CreateLocationAzureBlobRequest.Builder> createLocationAzureBlobRequest)
Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or destination.
Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your container.
This is a convenience which creates an instance of the CreateLocationAzureBlobRequest.Builder avoiding
the need to create one manually via CreateLocationAzureBlobRequest.builder()
createLocationAzureBlobRequest - A Consumer that will call methods on
CreateLocationAzureBlobRequest.Builder to create a
request.default CompletableFuture<CreateLocationEfsResponse> createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)
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.
createLocationEfsRequest - CreateLocationEfsRequestdefault CompletableFuture<CreateLocationEfsResponse> createLocationEfs(Consumer<CreateLocationEfsRequest.Builder> createLocationEfsRequest)
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.
This is a convenience which creates an instance of the CreateLocationEfsRequest.Builder avoiding the need
to create one manually via CreateLocationEfsRequest.builder()
createLocationEfsRequest - A Consumer that will call methods on
CreateLocationEfsRequest.Builder to create a
request. CreateLocationEfsRequestdefault CompletableFuture<CreateLocationFsxLustreResponse> createLocationFsxLustre(CreateLocationFsxLustreRequest createLocationFsxLustreRequest)
Creates an endpoint for an Amazon FSx for Lustre file system.
createLocationFsxLustreRequest - default CompletableFuture<CreateLocationFsxLustreResponse> createLocationFsxLustre(Consumer<CreateLocationFsxLustreRequest.Builder> createLocationFsxLustreRequest)
Creates an endpoint for an Amazon FSx for Lustre file system.
This is a convenience which creates an instance of the CreateLocationFsxLustreRequest.Builder avoiding
the need to create one manually via CreateLocationFsxLustreRequest.builder()
createLocationFsxLustreRequest - A Consumer that will call methods on
CreateLocationFsxLustreRequest.Builder to create a
request.default CompletableFuture<CreateLocationFsxOntapResponse> createLocationFsxOntap(CreateLocationFsxOntapRequest createLocationFsxOntapRequest)
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can use for a data transfer.
Before you begin, make sure that you understand how DataSync accesses an FSx for ONTAP file system.
createLocationFsxOntapRequest - default CompletableFuture<CreateLocationFsxOntapResponse> createLocationFsxOntap(Consumer<CreateLocationFsxOntapRequest.Builder> createLocationFsxOntapRequest)
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can use for a data transfer.
Before you begin, make sure that you understand how DataSync accesses an FSx for ONTAP file system.
This is a convenience which creates an instance of the CreateLocationFsxOntapRequest.Builder avoiding the
need to create one manually via CreateLocationFsxOntapRequest.builder()
createLocationFsxOntapRequest - A Consumer that will call methods on
CreateLocationFsxOntapRequest.Builder to create a
request.default CompletableFuture<CreateLocationFsxOpenZfsResponse> createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest)
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.
Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs
operation.
createLocationFsxOpenZfsRequest - default CompletableFuture<CreateLocationFsxOpenZfsResponse> createLocationFsxOpenZfs(Consumer<CreateLocationFsxOpenZfsRequest.Builder> createLocationFsxOpenZfsRequest)
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.
Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs
operation.
This is a convenience which creates an instance of the CreateLocationFsxOpenZfsRequest.Builder avoiding
the need to create one manually via CreateLocationFsxOpenZfsRequest.builder()
createLocationFsxOpenZfsRequest - A Consumer that will call methods on
CreateLocationFsxOpenZfsRequest.Builder to create a
request.default CompletableFuture<CreateLocationFsxWindowsResponse> createLocationFsxWindows(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest)
Creates an endpoint for an Amazon FSx for Windows File Server file system that DataSync can use for a data transfer.
Before you begin, make sure that you understand how DataSync accesses an FSx for Windows File Server.
createLocationFsxWindowsRequest - default CompletableFuture<CreateLocationFsxWindowsResponse> createLocationFsxWindows(Consumer<CreateLocationFsxWindowsRequest.Builder> createLocationFsxWindowsRequest)
Creates an endpoint for an Amazon FSx for Windows File Server file system that DataSync can use for a data transfer.
Before you begin, make sure that you understand how DataSync accesses an FSx for Windows File Server.
This is a convenience which creates an instance of the CreateLocationFsxWindowsRequest.Builder avoiding
the need to create one manually via CreateLocationFsxWindowsRequest.builder()
createLocationFsxWindowsRequest - A Consumer that will call methods on
CreateLocationFsxWindowsRequest.Builder to create a
request.default CompletableFuture<CreateLocationHdfsResponse> createLocationHdfs(CreateLocationHdfsRequest createLocationHdfsRequest)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
createLocationHdfsRequest - default CompletableFuture<CreateLocationHdfsResponse> createLocationHdfs(Consumer<CreateLocationHdfsRequest.Builder> createLocationHdfsRequest)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
This is a convenience which creates an instance of the CreateLocationHdfsRequest.Builder avoiding the
need to create one manually via CreateLocationHdfsRequest.builder()
createLocationHdfsRequest - A Consumer that will call methods on
CreateLocationHdfsRequest.Builder to create a
request.default CompletableFuture<CreateLocationNfsResponse> createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)
Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.
For more information, see Configuring transfers to or from an NFS file server.
If you're copying data to or from an Snowcone device, you can also use CreateLocationNfs to create
your transfer location. For more information, see Configuring transfers with
Snowcone.
createLocationNfsRequest - CreateLocationNfsRequestdefault CompletableFuture<CreateLocationNfsResponse> createLocationNfs(Consumer<CreateLocationNfsRequest.Builder> createLocationNfsRequest)
Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.
For more information, see Configuring transfers to or from an NFS file server.
If you're copying data to or from an Snowcone device, you can also use CreateLocationNfs to create
your transfer location. For more information, see Configuring transfers with
Snowcone.
This is a convenience which creates an instance of the CreateLocationNfsRequest.Builder avoiding the need
to create one manually via CreateLocationNfsRequest.builder()
createLocationNfsRequest - A Consumer that will call methods on
CreateLocationNfsRequest.Builder to create a
request. CreateLocationNfsRequestdefault CompletableFuture<CreateLocationObjectStorageResponse> createLocationObjectStorage(CreateLocationObjectStorageRequest createLocationObjectStorageRequest)
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.
createLocationObjectStorageRequest - CreateLocationObjectStorageRequestdefault CompletableFuture<CreateLocationObjectStorageResponse> createLocationObjectStorage(Consumer<CreateLocationObjectStorageRequest.Builder> createLocationObjectStorageRequest)
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.
This is a convenience which creates an instance of the CreateLocationObjectStorageRequest.Builder
avoiding the need to create one manually via CreateLocationObjectStorageRequest.builder()
createLocationObjectStorageRequest - A Consumer that will call methods on
CreateLocationObjectStorageRequest.Builder to
create a request. CreateLocationObjectStorageRequestdefault CompletableFuture<CreateLocationS3Response> createLocationS3(CreateLocationS3Request createLocationS3Request)
A location is an endpoint for an Amazon S3 bucket. DataSync can use the location as a source or destination for copying data.
Before you create your location, make sure that you read the following sections:
For more information, see Creating an Amazon S3 location.
createLocationS3Request - CreateLocationS3Requestdefault CompletableFuture<CreateLocationS3Response> createLocationS3(Consumer<CreateLocationS3Request.Builder> createLocationS3Request)
A location is an endpoint for an Amazon S3 bucket. DataSync can use the location as a source or destination for copying data.
Before you create your location, make sure that you read the following sections:
For more information, see Creating an Amazon S3 location.
This is a convenience which creates an instance of the CreateLocationS3Request.Builder avoiding the need
to create one manually via CreateLocationS3Request.builder()
createLocationS3Request - A Consumer that will call methods on
CreateLocationS3Request.Builder to create a
request. CreateLocationS3Requestdefault CompletableFuture<CreateLocationSmbResponse> createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest)
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can use for a data transfer.
Before you begin, make sure that you understand how DataSync accesses an SMB file server.
createLocationSmbRequest - CreateLocationSmbRequestdefault CompletableFuture<CreateLocationSmbResponse> createLocationSmb(Consumer<CreateLocationSmbRequest.Builder> createLocationSmbRequest)
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can use for a data transfer.
Before you begin, make sure that you understand how DataSync accesses an SMB file server.
This is a convenience which creates an instance of the CreateLocationSmbRequest.Builder avoiding the need
to create one manually via CreateLocationSmbRequest.builder()
createLocationSmbRequest - A Consumer that will call methods on
CreateLocationSmbRequest.Builder to create a
request. CreateLocationSmbRequestdefault CompletableFuture<CreateTaskResponse> createTask(CreateTaskRequest createTaskRequest)
Configures a transfer task, which defines where and how DataSync moves your data.
A task includes a source location, destination location, and the options for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
createTaskRequest - CreateTaskRequestdefault CompletableFuture<CreateTaskResponse> createTask(Consumer<CreateTaskRequest.Builder> createTaskRequest)
Configures a transfer task, which defines where and how DataSync moves your data.
A task includes a source location, destination location, and the options for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
This is a convenience which creates an instance of the CreateTaskRequest.Builder avoiding the need to
create one manually via CreateTaskRequest.builder()
createTaskRequest - A Consumer that will call methods on
CreateTaskRequest.Builder to create a request.
CreateTaskRequestdefault CompletableFuture<DeleteAgentResponse> deleteAgent(DeleteAgentRequest deleteAgentRequest)
Removes an DataSync agent resource from your Amazon Web Services account.
Keep in mind that this operation (which can't be undone) doesn't remove the agent's virtual machine (VM) or Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or instance from your storage environment or reuse it to activate a new agent.
deleteAgentRequest - DeleteAgentRequestdefault CompletableFuture<DeleteAgentResponse> deleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest)
Removes an DataSync agent resource from your Amazon Web Services account.
Keep in mind that this operation (which can't be undone) doesn't remove the agent's virtual machine (VM) or Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or instance from your storage environment or reuse it to activate a new agent.
This is a convenience which creates an instance of the DeleteAgentRequest.Builder avoiding the need to
create one manually via DeleteAgentRequest.builder()
deleteAgentRequest - A Consumer that will call methods on
DeleteAgentRequest.Builder to create a request.
DeleteAgentRequestdefault CompletableFuture<DeleteLocationResponse> deleteLocation(DeleteLocationRequest deleteLocationRequest)
Deletes the configuration of a location used by DataSync.
deleteLocationRequest - DeleteLocationdefault CompletableFuture<DeleteLocationResponse> deleteLocation(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest)
Deletes the configuration of a location used by DataSync.
This is a convenience which creates an instance of the DeleteLocationRequest.Builder avoiding the need to
create one manually via DeleteLocationRequest.builder()
deleteLocationRequest - A Consumer that will call methods on
DeleteLocationRequest.Builder to create a request.
DeleteLocationdefault CompletableFuture<DeleteTaskResponse> deleteTask(DeleteTaskRequest deleteTaskRequest)
Deletes an DataSync transfer task.
deleteTaskRequest - DeleteTaskdefault CompletableFuture<DeleteTaskResponse> deleteTask(Consumer<DeleteTaskRequest.Builder> deleteTaskRequest)
Deletes an DataSync transfer task.
This is a convenience which creates an instance of the DeleteTaskRequest.Builder avoiding the need to
create one manually via DeleteTaskRequest.builder()
deleteTaskRequest - A Consumer that will call methods on
DeleteTaskRequest.Builder to create a request.
DeleteTaskdefault CompletableFuture<DescribeAgentResponse> describeAgent(DescribeAgentRequest describeAgentRequest)
Returns information about an DataSync agent, such as its name, service endpoint type, and status.
describeAgentRequest - DescribeAgentdefault CompletableFuture<DescribeAgentResponse> describeAgent(Consumer<DescribeAgentRequest.Builder> describeAgentRequest)
Returns information about an DataSync agent, such as its name, service endpoint type, and status.
This is a convenience which creates an instance of the DescribeAgentRequest.Builder avoiding the need to
create one manually via DescribeAgentRequest.builder()
describeAgentRequest - A Consumer that will call methods on
DescribeAgentRequest.Builder to create a request.
DescribeAgentdefault CompletableFuture<DescribeDiscoveryJobResponse> describeDiscoveryJob(DescribeDiscoveryJobRequest describeDiscoveryJobRequest)
Returns information about a DataSync discovery job.
describeDiscoveryJobRequest - default CompletableFuture<DescribeDiscoveryJobResponse> describeDiscoveryJob(Consumer<DescribeDiscoveryJobRequest.Builder> describeDiscoveryJobRequest)
Returns information about a DataSync discovery job.
This is a convenience which creates an instance of the DescribeDiscoveryJobRequest.Builder avoiding the
need to create one manually via DescribeDiscoveryJobRequest.builder()
describeDiscoveryJobRequest - A Consumer that will call methods on
DescribeDiscoveryJobRequest.Builder to create a
request.default CompletableFuture<DescribeLocationAzureBlobResponse> describeLocationAzureBlob(DescribeLocationAzureBlobRequest describeLocationAzureBlobRequest)
Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
describeLocationAzureBlobRequest - default CompletableFuture<DescribeLocationAzureBlobResponse> describeLocationAzureBlob(Consumer<DescribeLocationAzureBlobRequest.Builder> describeLocationAzureBlobRequest)
Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
This is a convenience which creates an instance of the DescribeLocationAzureBlobRequest.Builder avoiding
the need to create one manually via DescribeLocationAzureBlobRequest.builder()
describeLocationAzureBlobRequest - A Consumer that will call methods on
DescribeLocationAzureBlobRequest.Builder to create
a request.default CompletableFuture<DescribeLocationEfsResponse> describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)
Returns metadata about your DataSync location for an Amazon EFS file system.
describeLocationEfsRequest - DescribeLocationEfsRequestdefault CompletableFuture<DescribeLocationEfsResponse> describeLocationEfs(Consumer<DescribeLocationEfsRequest.Builder> describeLocationEfsRequest)
Returns metadata about your DataSync location for an Amazon EFS file system.
This is a convenience which creates an instance of the DescribeLocationEfsRequest.Builder avoiding the
need to create one manually via DescribeLocationEfsRequest.builder()
describeLocationEfsRequest - A Consumer that will call methods on
DescribeLocationEfsRequest.Builder to create a
request. DescribeLocationEfsRequestdefault CompletableFuture<DescribeLocationFsxLustreResponse> describeLocationFsxLustre(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest)
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
describeLocationFsxLustreRequest - default CompletableFuture<DescribeLocationFsxLustreResponse> describeLocationFsxLustre(Consumer<DescribeLocationFsxLustreRequest.Builder> describeLocationFsxLustreRequest)
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
This is a convenience which creates an instance of the DescribeLocationFsxLustreRequest.Builder avoiding
the need to create one manually via DescribeLocationFsxLustreRequest.builder()
describeLocationFsxLustreRequest - A Consumer that will call methods on
DescribeLocationFsxLustreRequest.Builder to create
a request.default CompletableFuture<DescribeLocationFsxOntapResponse> describeLocationFsxOntap(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest)
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a
Password.
describeLocationFsxOntapRequest - default CompletableFuture<DescribeLocationFsxOntapResponse> describeLocationFsxOntap(Consumer<DescribeLocationFsxOntapRequest.Builder> describeLocationFsxOntapRequest)
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a
Password.
This is a convenience which creates an instance of the DescribeLocationFsxOntapRequest.Builder avoiding
the need to create one manually via DescribeLocationFsxOntapRequest.builder()
describeLocationFsxOntapRequest - A Consumer that will call methods on
DescribeLocationFsxOntapRequest.Builder to create a
request.default CompletableFuture<DescribeLocationFsxOpenZfsResponse> describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest)
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs
operation.
describeLocationFsxOpenZfsRequest - default CompletableFuture<DescribeLocationFsxOpenZfsResponse> describeLocationFsxOpenZfs(Consumer<DescribeLocationFsxOpenZfsRequest.Builder> describeLocationFsxOpenZfsRequest)
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs
operation.
This is a convenience which creates an instance of the DescribeLocationFsxOpenZfsRequest.Builder avoiding
the need to create one manually via DescribeLocationFsxOpenZfsRequest.builder()
describeLocationFsxOpenZfsRequest - A Consumer that will call methods on
DescribeLocationFsxOpenZfsRequest.Builder to create
a request.default CompletableFuture<DescribeLocationFsxWindowsResponse> describeLocationFsxWindows(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest)
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
describeLocationFsxWindowsRequest - default CompletableFuture<DescribeLocationFsxWindowsResponse> describeLocationFsxWindows(Consumer<DescribeLocationFsxWindowsRequest.Builder> describeLocationFsxWindowsRequest)
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
This is a convenience which creates an instance of the DescribeLocationFsxWindowsRequest.Builder avoiding
the need to create one manually via DescribeLocationFsxWindowsRequest.builder()
describeLocationFsxWindowsRequest - A Consumer that will call methods on
DescribeLocationFsxWindowsRequest.Builder to create
a request.default CompletableFuture<DescribeLocationHdfsResponse> describeLocationHdfs(DescribeLocationHdfsRequest describeLocationHdfsRequest)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
describeLocationHdfsRequest - default CompletableFuture<DescribeLocationHdfsResponse> describeLocationHdfs(Consumer<DescribeLocationHdfsRequest.Builder> describeLocationHdfsRequest)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
This is a convenience which creates an instance of the DescribeLocationHdfsRequest.Builder avoiding the
need to create one manually via DescribeLocationHdfsRequest.builder()
describeLocationHdfsRequest - A Consumer that will call methods on
DescribeLocationHdfsRequest.Builder to create a
request.default CompletableFuture<DescribeLocationNfsResponse> describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)
Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.
describeLocationNfsRequest - DescribeLocationNfsRequestdefault CompletableFuture<DescribeLocationNfsResponse> describeLocationNfs(Consumer<DescribeLocationNfsRequest.Builder> describeLocationNfsRequest)
Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.
This is a convenience which creates an instance of the DescribeLocationNfsRequest.Builder avoiding the
need to create one manually via DescribeLocationNfsRequest.builder()
describeLocationNfsRequest - A Consumer that will call methods on
DescribeLocationNfsRequest.Builder to create a
request. DescribeLocationNfsRequestdefault CompletableFuture<DescribeLocationObjectStorageResponse> describeLocationObjectStorage(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest)
Returns metadata about your DataSync location for an object storage system.
describeLocationObjectStorageRequest - DescribeLocationObjectStorageRequestdefault CompletableFuture<DescribeLocationObjectStorageResponse> describeLocationObjectStorage(Consumer<DescribeLocationObjectStorageRequest.Builder> describeLocationObjectStorageRequest)
Returns metadata about your DataSync location for an object storage system.
This is a convenience which creates an instance of the DescribeLocationObjectStorageRequest.Builder
avoiding the need to create one manually via DescribeLocationObjectStorageRequest.builder()
describeLocationObjectStorageRequest - A Consumer that will call methods on
DescribeLocationObjectStorageRequest.Builder to
create a request. DescribeLocationObjectStorageRequestdefault CompletableFuture<DescribeLocationS3Response> describeLocationS3(DescribeLocationS3Request describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3Request - DescribeLocationS3Requestdefault CompletableFuture<DescribeLocationS3Response> describeLocationS3(Consumer<DescribeLocationS3Request.Builder> describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
This is a convenience which creates an instance of the DescribeLocationS3Request.Builder avoiding the
need to create one manually via DescribeLocationS3Request.builder()
describeLocationS3Request - A Consumer that will call methods on
DescribeLocationS3Request.Builder to create a
request. DescribeLocationS3Requestdefault CompletableFuture<DescribeLocationSmbResponse> describeLocationSmb(DescribeLocationSmbRequest describeLocationSmbRequest)
Returns metadata, such as the path and user information about an SMB location.
describeLocationSmbRequest - DescribeLocationSmbRequestdefault CompletableFuture<DescribeLocationSmbResponse> describeLocationSmb(Consumer<DescribeLocationSmbRequest.Builder> describeLocationSmbRequest)
Returns metadata, such as the path and user information about an SMB location.
This is a convenience which creates an instance of the DescribeLocationSmbRequest.Builder avoiding the
need to create one manually via DescribeLocationSmbRequest.builder()
describeLocationSmbRequest - A Consumer that will call methods on
DescribeLocationSmbRequest.Builder to create a
request. DescribeLocationSmbRequestdefault CompletableFuture<DescribeStorageSystemResponse> describeStorageSystem(DescribeStorageSystemRequest describeStorageSystemRequest)
Returns information about an on-premises storage system that you're using with DataSync Discovery.
describeStorageSystemRequest - default CompletableFuture<DescribeStorageSystemResponse> describeStorageSystem(Consumer<DescribeStorageSystemRequest.Builder> describeStorageSystemRequest)
Returns information about an on-premises storage system that you're using with DataSync Discovery.
This is a convenience which creates an instance of the DescribeStorageSystemRequest.Builder avoiding the
need to create one manually via DescribeStorageSystemRequest.builder()
describeStorageSystemRequest - A Consumer that will call methods on
DescribeStorageSystemRequest.Builder to create a
request.default CompletableFuture<DescribeStorageSystemResourceMetricsResponse> describeStorageSystemResourceMetrics(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
describeStorageSystemResourceMetricsRequest - default CompletableFuture<DescribeStorageSystemResourceMetricsResponse> describeStorageSystemResourceMetrics(Consumer<DescribeStorageSystemResourceMetricsRequest.Builder> describeStorageSystemResourceMetricsRequest)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
This is a convenience which creates an instance of the
DescribeStorageSystemResourceMetricsRequest.Builder avoiding the need to create one manually via
DescribeStorageSystemResourceMetricsRequest.builder()
describeStorageSystemResourceMetricsRequest - A Consumer that will call methods on
DescribeStorageSystemResourceMetricsRequest.Builder
to create a request.default DescribeStorageSystemResourceMetricsPublisher describeStorageSystemResourceMetricsPaginator(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
This is a variant of
describeStorageSystemResourceMetrics(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourceMetricsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourceMetricsPublisher publisher = client.describeStorageSystemResourceMetricsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourceMetricsPublisher publisher = client.describeStorageSystemResourceMetricsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourceMetricsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourceMetricsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStorageSystemResourceMetrics(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourceMetricsRequest)
operation.
describeStorageSystemResourceMetricsRequest - default DescribeStorageSystemResourceMetricsPublisher describeStorageSystemResourceMetricsPaginator(Consumer<DescribeStorageSystemResourceMetricsRequest.Builder> describeStorageSystemResourceMetricsRequest)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
This is a variant of
describeStorageSystemResourceMetrics(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourceMetricsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourceMetricsPublisher publisher = client.describeStorageSystemResourceMetricsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourceMetricsPublisher publisher = client.describeStorageSystemResourceMetricsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourceMetricsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourceMetricsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStorageSystemResourceMetrics(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourceMetricsRequest)
operation.
This is a convenience which creates an instance of the
DescribeStorageSystemResourceMetricsRequest.Builder avoiding the need to create one manually via
DescribeStorageSystemResourceMetricsRequest.builder()
describeStorageSystemResourceMetricsRequest - A Consumer that will call methods on
DescribeStorageSystemResourceMetricsRequest.Builder
to create a request.default CompletableFuture<DescribeStorageSystemResourcesResponse> describeStorageSystemResources(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
describeStorageSystemResourcesRequest - default CompletableFuture<DescribeStorageSystemResourcesResponse> describeStorageSystemResources(Consumer<DescribeStorageSystemResourcesRequest.Builder> describeStorageSystemResourcesRequest)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
This is a convenience which creates an instance of the DescribeStorageSystemResourcesRequest.Builder
avoiding the need to create one manually via DescribeStorageSystemResourcesRequest.builder()
describeStorageSystemResourcesRequest - A Consumer that will call methods on
DescribeStorageSystemResourcesRequest.Builder to
create a request.default DescribeStorageSystemResourcesPublisher describeStorageSystemResourcesPaginator(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
This is a variant of
describeStorageSystemResources(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourcesPublisher publisher = client.describeStorageSystemResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourcesPublisher publisher = client.describeStorageSystemResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStorageSystemResources(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesRequest)
operation.
describeStorageSystemResourcesRequest - default DescribeStorageSystemResourcesPublisher describeStorageSystemResourcesPaginator(Consumer<DescribeStorageSystemResourcesRequest.Builder> describeStorageSystemResourcesRequest)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
This is a variant of
describeStorageSystemResources(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourcesPublisher publisher = client.describeStorageSystemResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourcesPublisher publisher = client.describeStorageSystemResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStorageSystemResources(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesRequest)
operation.
This is a convenience which creates an instance of the DescribeStorageSystemResourcesRequest.Builder
avoiding the need to create one manually via DescribeStorageSystemResourcesRequest.builder()
describeStorageSystemResourcesRequest - A Consumer that will call methods on
DescribeStorageSystemResourcesRequest.Builder to
create a request.default CompletableFuture<DescribeTaskResponse> describeTask(DescribeTaskRequest describeTaskRequest)
Provides information about an DataSync transfer task.
describeTaskRequest - DescribeTaskRequestdefault CompletableFuture<DescribeTaskResponse> describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest)
Provides information about an DataSync transfer task.
This is a convenience which creates an instance of the DescribeTaskRequest.Builder avoiding the need to
create one manually via DescribeTaskRequest.builder()
describeTaskRequest - A Consumer that will call methods on
DescribeTaskRequest.Builder to create a request.
DescribeTaskRequestdefault CompletableFuture<DescribeTaskExecutionResponse> describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)
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.
describeTaskExecutionRequest - DescribeTaskExecutionRequestdefault CompletableFuture<DescribeTaskExecutionResponse> describeTaskExecution(Consumer<DescribeTaskExecutionRequest.Builder> describeTaskExecutionRequest)
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.
This is a convenience which creates an instance of the DescribeTaskExecutionRequest.Builder avoiding the
need to create one manually via DescribeTaskExecutionRequest.builder()
describeTaskExecutionRequest - A Consumer that will call methods on
DescribeTaskExecutionRequest.Builder to create a
request. DescribeTaskExecutionRequestdefault CompletableFuture<GenerateRecommendationsResponse> generateRecommendations(GenerateRecommendationsRequest generateRecommendationsRequest)
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.
Once generated, you can view your recommendations by using the DescribeStorageSystemResources operation.
generateRecommendationsRequest - default CompletableFuture<GenerateRecommendationsResponse> generateRecommendations(Consumer<GenerateRecommendationsRequest.Builder> generateRecommendationsRequest)
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.
Once generated, you can view your recommendations by using the DescribeStorageSystemResources operation.
This is a convenience which creates an instance of the GenerateRecommendationsRequest.Builder avoiding
the need to create one manually via GenerateRecommendationsRequest.builder()
generateRecommendationsRequest - A Consumer that will call methods on
GenerateRecommendationsRequest.Builder to create a
request.default CompletableFuture<ListAgentsResponse> listAgents(ListAgentsRequest listAgentsRequest)
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.
listAgentsRequest - ListAgentsRequestdefault CompletableFuture<ListAgentsResponse> listAgents(Consumer<ListAgentsRequest.Builder> listAgentsRequest)
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.
This is a convenience which creates an instance of the ListAgentsRequest.Builder avoiding the need to
create one manually via ListAgentsRequest.builder()
listAgentsRequest - A Consumer that will call methods on
ListAgentsRequest.Builder to create a request.
ListAgentsRequestdefault CompletableFuture<ListAgentsResponse> listAgents()
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.
default ListAgentsPublisher listAgentsPaginator()
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.
This is a variant of listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListAgentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListAgentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest) operation.
default ListAgentsPublisher listAgentsPaginator(ListAgentsRequest listAgentsRequest)
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.
This is a variant of listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListAgentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListAgentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest) operation.
listAgentsRequest - ListAgentsRequestdefault ListAgentsPublisher listAgentsPaginator(Consumer<ListAgentsRequest.Builder> listAgentsRequest)
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.
This is a variant of listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListAgentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListAgentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest) operation.
This is a convenience which creates an instance of the ListAgentsRequest.Builder avoiding the need to
create one manually via ListAgentsRequest.builder()
listAgentsRequest - A Consumer that will call methods on
ListAgentsRequest.Builder to create a request.
ListAgentsRequestdefault CompletableFuture<ListDiscoveryJobsResponse> listDiscoveryJobs(ListDiscoveryJobsRequest listDiscoveryJobsRequest)
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.
listDiscoveryJobsRequest - default CompletableFuture<ListDiscoveryJobsResponse> listDiscoveryJobs(Consumer<ListDiscoveryJobsRequest.Builder> listDiscoveryJobsRequest)
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.
This is a convenience which creates an instance of the ListDiscoveryJobsRequest.Builder avoiding the need
to create one manually via ListDiscoveryJobsRequest.builder()
listDiscoveryJobsRequest - A Consumer that will call methods on
ListDiscoveryJobsRequest.Builder to create a
request.default ListDiscoveryJobsPublisher listDiscoveryJobsPaginator(ListDiscoveryJobsRequest listDiscoveryJobsRequest)
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.
This is a variant of
listDiscoveryJobs(software.amazon.awssdk.services.datasync.model.ListDiscoveryJobsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListDiscoveryJobsPublisher publisher = client.listDiscoveryJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListDiscoveryJobsPublisher publisher = client.listDiscoveryJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListDiscoveryJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListDiscoveryJobsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDiscoveryJobs(software.amazon.awssdk.services.datasync.model.ListDiscoveryJobsRequest)
operation.
listDiscoveryJobsRequest - default ListDiscoveryJobsPublisher listDiscoveryJobsPaginator(Consumer<ListDiscoveryJobsRequest.Builder> listDiscoveryJobsRequest)
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.
This is a variant of
listDiscoveryJobs(software.amazon.awssdk.services.datasync.model.ListDiscoveryJobsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListDiscoveryJobsPublisher publisher = client.listDiscoveryJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListDiscoveryJobsPublisher publisher = client.listDiscoveryJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListDiscoveryJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListDiscoveryJobsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDiscoveryJobs(software.amazon.awssdk.services.datasync.model.ListDiscoveryJobsRequest)
operation.
This is a convenience which creates an instance of the ListDiscoveryJobsRequest.Builder avoiding the need
to create one manually via ListDiscoveryJobsRequest.builder()
listDiscoveryJobsRequest - A Consumer that will call methods on
ListDiscoveryJobsRequest.Builder to create a
request.default CompletableFuture<ListLocationsResponse> listLocations(ListLocationsRequest listLocationsRequest)
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.
listLocationsRequest - ListLocationsRequestdefault CompletableFuture<ListLocationsResponse> listLocations(Consumer<ListLocationsRequest.Builder> listLocationsRequest)
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.
This is a convenience which creates an instance of the ListLocationsRequest.Builder avoiding the need to
create one manually via ListLocationsRequest.builder()
listLocationsRequest - A Consumer that will call methods on
ListLocationsRequest.Builder to create a request.
ListLocationsRequestdefault CompletableFuture<ListLocationsResponse> listLocations()
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.
default ListLocationsPublisher listLocationsPaginator()
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.
This is a variant of listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListLocationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListLocationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest) operation.
default ListLocationsPublisher listLocationsPaginator(ListLocationsRequest listLocationsRequest)
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.
This is a variant of listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListLocationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListLocationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest) operation.
listLocationsRequest - ListLocationsRequestdefault ListLocationsPublisher listLocationsPaginator(Consumer<ListLocationsRequest.Builder> listLocationsRequest)
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.
This is a variant of listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListLocationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListLocationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest) operation.
This is a convenience which creates an instance of the ListLocationsRequest.Builder avoiding the need to
create one manually via ListLocationsRequest.builder()
listLocationsRequest - A Consumer that will call methods on
ListLocationsRequest.Builder to create a request.
ListLocationsRequestdefault CompletableFuture<ListStorageSystemsResponse> listStorageSystems(ListStorageSystemsRequest listStorageSystemsRequest)
Lists the on-premises storage systems that you're using with DataSync Discovery.
listStorageSystemsRequest - default CompletableFuture<ListStorageSystemsResponse> listStorageSystems(Consumer<ListStorageSystemsRequest.Builder> listStorageSystemsRequest)
Lists the on-premises storage systems that you're using with DataSync Discovery.
This is a convenience which creates an instance of the ListStorageSystemsRequest.Builder avoiding the
need to create one manually via ListStorageSystemsRequest.builder()
listStorageSystemsRequest - A Consumer that will call methods on
ListStorageSystemsRequest.Builder to create a
request.default ListStorageSystemsPublisher listStorageSystemsPaginator(ListStorageSystemsRequest listStorageSystemsRequest)
Lists the on-premises storage systems that you're using with DataSync Discovery.
This is a variant of
listStorageSystems(software.amazon.awssdk.services.datasync.model.ListStorageSystemsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListStorageSystemsPublisher publisher = client.listStorageSystemsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListStorageSystemsPublisher publisher = client.listStorageSystemsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListStorageSystemsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListStorageSystemsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStorageSystems(software.amazon.awssdk.services.datasync.model.ListStorageSystemsRequest)
operation.
listStorageSystemsRequest - default ListStorageSystemsPublisher listStorageSystemsPaginator(Consumer<ListStorageSystemsRequest.Builder> listStorageSystemsRequest)
Lists the on-premises storage systems that you're using with DataSync Discovery.
This is a variant of
listStorageSystems(software.amazon.awssdk.services.datasync.model.ListStorageSystemsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListStorageSystemsPublisher publisher = client.listStorageSystemsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListStorageSystemsPublisher publisher = client.listStorageSystemsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListStorageSystemsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListStorageSystemsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStorageSystems(software.amazon.awssdk.services.datasync.model.ListStorageSystemsRequest)
operation.
This is a convenience which creates an instance of the ListStorageSystemsRequest.Builder avoiding the
need to create one manually via ListStorageSystemsRequest.builder()
listStorageSystemsRequest - A Consumer that will call methods on
ListStorageSystemsRequest.Builder to create a
request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
listTagsForResourceRequest - ListTagsForResourceRequestdefault CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request. ListTagsForResourceRequestdefault ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest)
operation.
listTagsForResourceRequest - ListTagsForResourceRequestdefault ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request. ListTagsForResourceRequestdefault CompletableFuture<ListTaskExecutionsResponse> listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
listTaskExecutionsRequest - ListTaskExecutionsdefault CompletableFuture<ListTaskExecutionsResponse> listTaskExecutions(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)
Returns a list of executed tasks.
This is a convenience which creates an instance of the ListTaskExecutionsRequest.Builder avoiding the
need to create one manually via ListTaskExecutionsRequest.builder()
listTaskExecutionsRequest - A Consumer that will call methods on
ListTaskExecutionsRequest.Builder to create a
request. ListTaskExecutionsdefault CompletableFuture<ListTaskExecutionsResponse> listTaskExecutions()
Returns a list of executed tasks.
default ListTaskExecutionsPublisher listTaskExecutionsPaginator()
Returns a list of executed tasks.
This is a variant of
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsPublisher publisher = client.listTaskExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsPublisher publisher = client.listTaskExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)
operation.
default ListTaskExecutionsPublisher listTaskExecutionsPaginator(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
This is a variant of
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsPublisher publisher = client.listTaskExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsPublisher publisher = client.listTaskExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)
operation.
listTaskExecutionsRequest - ListTaskExecutionsdefault ListTaskExecutionsPublisher listTaskExecutionsPaginator(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)
Returns a list of executed tasks.
This is a variant of
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsPublisher publisher = client.listTaskExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsPublisher publisher = client.listTaskExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)
operation.
This is a convenience which creates an instance of the ListTaskExecutionsRequest.Builder avoiding the
need to create one manually via ListTaskExecutionsRequest.builder()
listTaskExecutionsRequest - A Consumer that will call methods on
ListTaskExecutionsRequest.Builder to create a
request. ListTaskExecutionsdefault CompletableFuture<ListTasksResponse> listTasks(ListTasksRequest listTasksRequest)
Returns a list of the DataSync tasks you created.
listTasksRequest - ListTasksRequestdefault CompletableFuture<ListTasksResponse> listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of the DataSync tasks you created.
This is a convenience which creates an instance of the ListTasksRequest.Builder avoiding the need to
create one manually via ListTasksRequest.builder()
listTasksRequest - A Consumer that will call methods on
ListTasksRequest.Builder to create a request.
ListTasksRequestdefault CompletableFuture<ListTasksResponse> listTasks()
Returns a list of the DataSync tasks you created.
default ListTasksPublisher listTasksPaginator()
Returns a list of the DataSync tasks you created.
This is a variant of listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest) operation.
default ListTasksPublisher listTasksPaginator(ListTasksRequest listTasksRequest)
Returns a list of the DataSync tasks you created.
This is a variant of listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest) operation.
listTasksRequest - ListTasksRequestdefault ListTasksPublisher listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of the DataSync tasks you created.
This is a variant of listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest) operation.
This is a convenience which creates an instance of the ListTasksRequest.Builder avoiding the need to
create one manually via ListTasksRequest.builder()
listTasksRequest - A Consumer that will call methods on
ListTasksRequest.Builder to create a request.
ListTasksRequestdefault CompletableFuture<RemoveStorageSystemResponse> removeStorageSystem(RemoveStorageSystemRequest removeStorageSystemRequest)
Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.
removeStorageSystemRequest - default CompletableFuture<RemoveStorageSystemResponse> removeStorageSystem(Consumer<RemoveStorageSystemRequest.Builder> removeStorageSystemRequest)
Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.
This is a convenience which creates an instance of the RemoveStorageSystemRequest.Builder avoiding the
need to create one manually via RemoveStorageSystemRequest.builder()
removeStorageSystemRequest - A Consumer that will call methods on
RemoveStorageSystemRequest.Builder to create a
request.default CompletableFuture<StartDiscoveryJobResponse> startDiscoveryJob(StartDiscoveryJobRequest startDiscoveryJobRequest)
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.
startDiscoveryJobRequest - default CompletableFuture<StartDiscoveryJobResponse> startDiscoveryJob(Consumer<StartDiscoveryJobRequest.Builder> startDiscoveryJobRequest)
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.
This is a convenience which creates an instance of the StartDiscoveryJobRequest.Builder avoiding the need
to create one manually via StartDiscoveryJobRequest.builder()
startDiscoveryJobRequest - A Consumer that will call methods on
StartDiscoveryJobRequest.Builder to create a
request.default CompletableFuture<StartTaskExecutionResponse> startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest)
Starts an DataSync transfer 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.
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
startTaskExecutionRequest - StartTaskExecutionRequestdefault CompletableFuture<StartTaskExecutionResponse> startTaskExecution(Consumer<StartTaskExecutionRequest.Builder> startTaskExecutionRequest)
Starts an DataSync transfer 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.
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
This is a convenience which creates an instance of the StartTaskExecutionRequest.Builder avoiding the
need to create one manually via StartTaskExecutionRequest.builder()
startTaskExecutionRequest - A Consumer that will call methods on
StartTaskExecutionRequest.Builder to create a
request. StartTaskExecutionRequestdefault CompletableFuture<StopDiscoveryJobResponse> stopDiscoveryJob(StopDiscoveryJobRequest stopDiscoveryJobRequest)
Stops a running DataSync discovery job.
You can stop a discovery job anytime. A job that's stopped before it's scheduled to end likely will provide you some information about your on-premises storage system resources. To get recommendations for a stopped job, you must use the GenerateRecommendations operation.
stopDiscoveryJobRequest - default CompletableFuture<StopDiscoveryJobResponse> stopDiscoveryJob(Consumer<StopDiscoveryJobRequest.Builder> stopDiscoveryJobRequest)
Stops a running DataSync discovery job.
You can stop a discovery job anytime. A job that's stopped before it's scheduled to end likely will provide you some information about your on-premises storage system resources. To get recommendations for a stopped job, you must use the GenerateRecommendations operation.
This is a convenience which creates an instance of the StopDiscoveryJobRequest.Builder avoiding the need
to create one manually via StopDiscoveryJobRequest.builder()
stopDiscoveryJobRequest - A Consumer that will call methods on
StopDiscoveryJobRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - TagResourceRequestdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
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.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.
TagResourceRequestdefault CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
untagResourceRequest - UntagResourceRequestdefault CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from an Amazon Web Services resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.
UntagResourceRequestdefault CompletableFuture<UpdateAgentResponse> updateAgent(UpdateAgentRequest updateAgentRequest)
Updates the name of an DataSync agent.
updateAgentRequest - UpdateAgentRequestdefault CompletableFuture<UpdateAgentResponse> updateAgent(Consumer<UpdateAgentRequest.Builder> updateAgentRequest)
Updates the name of an DataSync agent.
This is a convenience which creates an instance of the UpdateAgentRequest.Builder avoiding the need to
create one manually via UpdateAgentRequest.builder()
updateAgentRequest - A Consumer that will call methods on
UpdateAgentRequest.Builder to create a request.
UpdateAgentRequestdefault CompletableFuture<UpdateDiscoveryJobResponse> updateDiscoveryJob(UpdateDiscoveryJobRequest updateDiscoveryJobRequest)
Edits a DataSync discovery job configuration.
updateDiscoveryJobRequest - default CompletableFuture<UpdateDiscoveryJobResponse> updateDiscoveryJob(Consumer<UpdateDiscoveryJobRequest.Builder> updateDiscoveryJobRequest)
Edits a DataSync discovery job configuration.
This is a convenience which creates an instance of the UpdateDiscoveryJobRequest.Builder avoiding the
need to create one manually via UpdateDiscoveryJobRequest.builder()
updateDiscoveryJobRequest - A Consumer that will call methods on
UpdateDiscoveryJobRequest.Builder to create a
request.default CompletableFuture<UpdateLocationAzureBlobResponse> updateLocationAzureBlob(UpdateLocationAzureBlobRequest updateLocationAzureBlobRequest)
Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
updateLocationAzureBlobRequest - default CompletableFuture<UpdateLocationAzureBlobResponse> updateLocationAzureBlob(Consumer<UpdateLocationAzureBlobRequest.Builder> updateLocationAzureBlobRequest)
Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
This is a convenience which creates an instance of the UpdateLocationAzureBlobRequest.Builder avoiding
the need to create one manually via UpdateLocationAzureBlobRequest.builder()
updateLocationAzureBlobRequest - A Consumer that will call methods on
UpdateLocationAzureBlobRequest.Builder to create a
request.default CompletableFuture<UpdateLocationHdfsResponse> updateLocationHdfs(UpdateLocationHdfsRequest updateLocationHdfsRequest)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
updateLocationHdfsRequest - default CompletableFuture<UpdateLocationHdfsResponse> updateLocationHdfs(Consumer<UpdateLocationHdfsRequest.Builder> updateLocationHdfsRequest)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
This is a convenience which creates an instance of the UpdateLocationHdfsRequest.Builder avoiding the
need to create one manually via UpdateLocationHdfsRequest.builder()
updateLocationHdfsRequest - A Consumer that will call methods on
UpdateLocationHdfsRequest.Builder to create a
request.default CompletableFuture<UpdateLocationNfsResponse> updateLocationNfs(UpdateLocationNfsRequest updateLocationNfsRequest)
Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.
For more information, see Configuring transfers to or from an NFS file server.
updateLocationNfsRequest - default CompletableFuture<UpdateLocationNfsResponse> updateLocationNfs(Consumer<UpdateLocationNfsRequest.Builder> updateLocationNfsRequest)
Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.
For more information, see Configuring transfers to or from an NFS file server.
This is a convenience which creates an instance of the UpdateLocationNfsRequest.Builder avoiding the need
to create one manually via UpdateLocationNfsRequest.builder()
updateLocationNfsRequest - A Consumer that will call methods on
UpdateLocationNfsRequest.Builder to create a
request.default CompletableFuture<UpdateLocationObjectStorageResponse> updateLocationObjectStorage(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest)
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.
updateLocationObjectStorageRequest - default CompletableFuture<UpdateLocationObjectStorageResponse> updateLocationObjectStorage(Consumer<UpdateLocationObjectStorageRequest.Builder> updateLocationObjectStorageRequest)
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.
This is a convenience which creates an instance of the UpdateLocationObjectStorageRequest.Builder
avoiding the need to create one manually via UpdateLocationObjectStorageRequest.builder()
updateLocationObjectStorageRequest - A Consumer that will call methods on
UpdateLocationObjectStorageRequest.Builder to
create a request.default CompletableFuture<UpdateLocationSmbResponse> updateLocationSmb(UpdateLocationSmbRequest updateLocationSmbRequest)
Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.
updateLocationSmbRequest - default CompletableFuture<UpdateLocationSmbResponse> updateLocationSmb(Consumer<UpdateLocationSmbRequest.Builder> updateLocationSmbRequest)
Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.
This is a convenience which creates an instance of the UpdateLocationSmbRequest.Builder avoiding the need
to create one manually via UpdateLocationSmbRequest.builder()
updateLocationSmbRequest - A Consumer that will call methods on
UpdateLocationSmbRequest.Builder to create a
request.default CompletableFuture<UpdateStorageSystemResponse> updateStorageSystem(UpdateStorageSystemRequest updateStorageSystemRequest)
Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
updateStorageSystemRequest - default CompletableFuture<UpdateStorageSystemResponse> updateStorageSystem(Consumer<UpdateStorageSystemRequest.Builder> updateStorageSystemRequest)
Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
This is a convenience which creates an instance of the UpdateStorageSystemRequest.Builder avoiding the
need to create one manually via UpdateStorageSystemRequest.builder()
updateStorageSystemRequest - A Consumer that will call methods on
UpdateStorageSystemRequest.Builder to create a
request.default CompletableFuture<UpdateTaskResponse> updateTask(UpdateTaskRequest updateTaskRequest)
Updates the configuration of a DataSync transfer task.
updateTaskRequest - UpdateTaskResponsedefault CompletableFuture<UpdateTaskResponse> updateTask(Consumer<UpdateTaskRequest.Builder> updateTaskRequest)
Updates the configuration of a DataSync transfer task.
This is a convenience which creates an instance of the UpdateTaskRequest.Builder avoiding the need to
create one manually via UpdateTaskRequest.builder()
updateTaskRequest - A Consumer that will call methods on
UpdateTaskRequest.Builder to create a request.
UpdateTaskResponsedefault CompletableFuture<UpdateTaskExecutionResponse> updateTaskExecution(UpdateTaskExecutionRequest updateTaskExecutionRequest)
Updates the configuration of a running DataSync task execution.
Currently, the only Option that you can modify with UpdateTaskExecution is
BytesPerSecond
, which throttles bandwidth for a running or queued task execution.
updateTaskExecutionRequest - default CompletableFuture<UpdateTaskExecutionResponse> updateTaskExecution(Consumer<UpdateTaskExecutionRequest.Builder> updateTaskExecutionRequest)
Updates the configuration of a running DataSync task execution.
Currently, the only Option that you can modify with UpdateTaskExecution is
BytesPerSecond
, which throttles bandwidth for a running or queued task execution.
This is a convenience which creates an instance of the UpdateTaskExecutionRequest.Builder avoiding the
need to create one manually via UpdateTaskExecutionRequest.builder()
updateTaskExecutionRequest - A Consumer that will call methods on
UpdateTaskExecutionRequest.Builder to create a
request.default DataSyncServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic DataSyncAsyncClient create()
DataSyncAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static DataSyncAsyncClientBuilder builder()
DataSyncAsyncClient.Copyright © 2023. All rights reserved.