Interface DataSyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
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 .
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault AddStorageSystemResponseaddStorageSystem(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.default AddStorageSystemResponseaddStorageSystem(AddStorageSystemRequest addStorageSystemRequest) Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.static DataSyncClientBuilderbuilder()Create a builder that can be used to configure and create aDataSyncClient.default CancelTaskExecutionResponsecancelTaskExecution(Consumer<CancelTaskExecutionRequest.Builder> cancelTaskExecutionRequest) Stops an DataSync task execution that's in progress.default CancelTaskExecutionResponsecancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest) Stops an DataSync task execution that's in progress.static DataSyncClientcreate()Create aDataSyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAgentResponsecreateAgent(Consumer<CreateAgentRequest.Builder> createAgentRequest) Activates an DataSync agent that you've deployed in your storage environment.default CreateAgentResponsecreateAgent(CreateAgentRequest createAgentRequest) Activates an DataSync agent that you've deployed in your storage environment.default CreateLocationAzureBlobResponsecreateLocationAzureBlob(Consumer<CreateLocationAzureBlobRequest.Builder> createLocationAzureBlobRequest) Creates a transfer location for a Microsoft Azure Blob Storage container.default CreateLocationAzureBlobResponsecreateLocationAzureBlob(CreateLocationAzureBlobRequest createLocationAzureBlobRequest) Creates a transfer location for a Microsoft Azure Blob Storage container.default CreateLocationEfsResponsecreateLocationEfs(Consumer<CreateLocationEfsRequest.Builder> createLocationEfsRequest) Creates a transfer location for an Amazon EFS file system.default CreateLocationEfsResponsecreateLocationEfs(CreateLocationEfsRequest createLocationEfsRequest) Creates a transfer location for an Amazon EFS file system.default CreateLocationFsxLustreResponsecreateLocationFsxLustre(Consumer<CreateLocationFsxLustreRequest.Builder> createLocationFsxLustreRequest) Creates a transfer location for an Amazon FSx for Lustre file system.default CreateLocationFsxLustreResponsecreateLocationFsxLustre(CreateLocationFsxLustreRequest createLocationFsxLustreRequest) Creates a transfer location for an Amazon FSx for Lustre file system.default CreateLocationFsxOntapResponsecreateLocationFsxOntap(Consumer<CreateLocationFsxOntapRequest.Builder> createLocationFsxOntapRequest) Creates a transfer location for an Amazon FSx for NetApp ONTAP file system.default CreateLocationFsxOntapResponsecreateLocationFsxOntap(CreateLocationFsxOntapRequest createLocationFsxOntapRequest) Creates a transfer location for an Amazon FSx for NetApp ONTAP file system.default CreateLocationFsxOpenZfsResponsecreateLocationFsxOpenZfs(Consumer<CreateLocationFsxOpenZfsRequest.Builder> createLocationFsxOpenZfsRequest) Creates a transfer location for an Amazon FSx for OpenZFS file system.default CreateLocationFsxOpenZfsResponsecreateLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest) Creates a transfer location for an Amazon FSx for OpenZFS file system.default CreateLocationFsxWindowsResponsecreateLocationFsxWindows(Consumer<CreateLocationFsxWindowsRequest.Builder> createLocationFsxWindowsRequest) Creates a transfer location for an Amazon FSx for Windows File Server file system.default CreateLocationFsxWindowsResponsecreateLocationFsxWindows(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest) Creates a transfer location for an Amazon FSx for Windows File Server file system.default CreateLocationHdfsResponsecreateLocationHdfs(Consumer<CreateLocationHdfsRequest.Builder> createLocationHdfsRequest) Creates a transfer location for a Hadoop Distributed File System (HDFS).default CreateLocationHdfsResponsecreateLocationHdfs(CreateLocationHdfsRequest createLocationHdfsRequest) Creates a transfer location for a Hadoop Distributed File System (HDFS).default CreateLocationNfsResponsecreateLocationNfs(Consumer<CreateLocationNfsRequest.Builder> createLocationNfsRequest) Creates a transfer location for a Network File System (NFS) file server.default CreateLocationNfsResponsecreateLocationNfs(CreateLocationNfsRequest createLocationNfsRequest) Creates a transfer location for a Network File System (NFS) file server.createLocationObjectStorage(Consumer<CreateLocationObjectStorageRequest.Builder> createLocationObjectStorageRequest) Creates a transfer location for an object storage system.createLocationObjectStorage(CreateLocationObjectStorageRequest createLocationObjectStorageRequest) Creates a transfer location for an object storage system.default CreateLocationS3ResponsecreateLocationS3(Consumer<CreateLocationS3Request.Builder> createLocationS3Request) Creates a transfer location for an Amazon S3 bucket.default CreateLocationS3ResponsecreateLocationS3(CreateLocationS3Request createLocationS3Request) Creates a transfer location for an Amazon S3 bucket.default CreateLocationSmbResponsecreateLocationSmb(Consumer<CreateLocationSmbRequest.Builder> createLocationSmbRequest) Creates a transfer location for a Server Message Block (SMB) file server.default CreateLocationSmbResponsecreateLocationSmb(CreateLocationSmbRequest createLocationSmbRequest) Creates a transfer location for a Server Message Block (SMB) file server.default CreateTaskResponsecreateTask(Consumer<CreateTaskRequest.Builder> createTaskRequest) Configures a task, which defines where and how DataSync transfers your data.default CreateTaskResponsecreateTask(CreateTaskRequest createTaskRequest) Configures a task, which defines where and how DataSync transfers your data.default DeleteAgentResponsedeleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest) Removes an DataSync agent resource from your Amazon Web Services account.default DeleteAgentResponsedeleteAgent(DeleteAgentRequest deleteAgentRequest) Removes an DataSync agent resource from your Amazon Web Services account.default DeleteLocationResponsedeleteLocation(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest) Deletes a transfer location resource from DataSync.default DeleteLocationResponsedeleteLocation(DeleteLocationRequest deleteLocationRequest) Deletes a transfer location resource from DataSync.default DeleteTaskResponsedeleteTask(Consumer<DeleteTaskRequest.Builder> deleteTaskRequest) Deletes a transfer task resource from DataSync.default DeleteTaskResponsedeleteTask(DeleteTaskRequest deleteTaskRequest) Deletes a transfer task resource from DataSync.default DescribeAgentResponsedescribeAgent(Consumer<DescribeAgentRequest.Builder> describeAgentRequest) Returns information about an DataSync agent, such as its name, service endpoint type, and status.default DescribeAgentResponsedescribeAgent(DescribeAgentRequest describeAgentRequest) Returns information about an DataSync agent, such as its name, service endpoint type, and status.default DescribeDiscoveryJobResponsedescribeDiscoveryJob(Consumer<DescribeDiscoveryJobRequest.Builder> describeDiscoveryJobRequest) Returns information about a DataSync discovery job.default DescribeDiscoveryJobResponsedescribeDiscoveryJob(DescribeDiscoveryJobRequest describeDiscoveryJobRequest) Returns information about a DataSync discovery job.describeLocationAzureBlob(Consumer<DescribeLocationAzureBlobRequest.Builder> describeLocationAzureBlobRequest) Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.describeLocationAzureBlob(DescribeLocationAzureBlobRequest describeLocationAzureBlobRequest) Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.default DescribeLocationEfsResponsedescribeLocationEfs(Consumer<DescribeLocationEfsRequest.Builder> describeLocationEfsRequest) Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.default DescribeLocationEfsResponsedescribeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest) Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.describeLocationFsxLustre(Consumer<DescribeLocationFsxLustreRequest.Builder> describeLocationFsxLustreRequest) Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.describeLocationFsxLustre(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest) Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.default DescribeLocationFsxOntapResponsedescribeLocationFsxOntap(Consumer<DescribeLocationFsxOntapRequest.Builder> describeLocationFsxOntapRequest) Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.default DescribeLocationFsxOntapResponsedescribeLocationFsxOntap(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest) Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.describeLocationFsxOpenZfs(Consumer<DescribeLocationFsxOpenZfsRequest.Builder> describeLocationFsxOpenZfsRequest) Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured.describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest) Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured.describeLocationFsxWindows(Consumer<DescribeLocationFsxWindowsRequest.Builder> describeLocationFsxWindowsRequest) Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.describeLocationFsxWindows(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest) Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.default DescribeLocationHdfsResponsedescribeLocationHdfs(Consumer<DescribeLocationHdfsRequest.Builder> describeLocationHdfsRequest) Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.default DescribeLocationHdfsResponsedescribeLocationHdfs(DescribeLocationHdfsRequest describeLocationHdfsRequest) Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.default DescribeLocationNfsResponsedescribeLocationNfs(Consumer<DescribeLocationNfsRequest.Builder> describeLocationNfsRequest) Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.default DescribeLocationNfsResponsedescribeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest) Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.describeLocationObjectStorage(Consumer<DescribeLocationObjectStorageRequest.Builder> describeLocationObjectStorageRequest) Provides details about how an DataSync transfer location for an object storage system is configured.describeLocationObjectStorage(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest) Provides details about how an DataSync transfer location for an object storage system is configured.default DescribeLocationS3ResponsedescribeLocationS3(Consumer<DescribeLocationS3Request.Builder> describeLocationS3Request) Provides details about how an DataSync transfer location for an S3 bucket is configured.default DescribeLocationS3ResponsedescribeLocationS3(DescribeLocationS3Request describeLocationS3Request) Provides details about how an DataSync transfer location for an S3 bucket is configured.default DescribeLocationSmbResponsedescribeLocationSmb(Consumer<DescribeLocationSmbRequest.Builder> describeLocationSmbRequest) Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.default DescribeLocationSmbResponsedescribeLocationSmb(DescribeLocationSmbRequest describeLocationSmbRequest) Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.default DescribeStorageSystemResponsedescribeStorageSystem(Consumer<DescribeStorageSystemRequest.Builder> describeStorageSystemRequest) Returns information about an on-premises storage system that you're using with DataSync Discovery.default DescribeStorageSystemResponsedescribeStorageSystem(DescribeStorageSystemRequest describeStorageSystemRequest) Returns information about an on-premises storage system that you're using with DataSync Discovery.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.describeStorageSystemResourceMetrics(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest) Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.describeStorageSystemResourceMetricsPaginator(Consumer<DescribeStorageSystemResourceMetricsRequest.Builder> describeStorageSystemResourceMetricsRequest) This is a variant ofdescribeStorageSystemResourceMetrics(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourceMetricsRequest)operation.describeStorageSystemResourceMetricsPaginator(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest) This is a variant ofdescribeStorageSystemResourceMetrics(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourceMetricsRequest)operation.describeStorageSystemResources(Consumer<DescribeStorageSystemResourcesRequest.Builder> describeStorageSystemResourcesRequest) Returns information that DataSync Discovery collects about resources in your on-premises storage system.describeStorageSystemResources(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest) Returns information that DataSync Discovery collects about resources in your on-premises storage system.describeStorageSystemResourcesPaginator(Consumer<DescribeStorageSystemResourcesRequest.Builder> describeStorageSystemResourcesRequest) This is a variant ofdescribeStorageSystemResources(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesRequest)operation.describeStorageSystemResourcesPaginator(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest) This is a variant ofdescribeStorageSystemResources(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesRequest)operation.default DescribeTaskResponsedescribeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest) Provides information about a task, which defines where and how DataSync transfers your data.default DescribeTaskResponsedescribeTask(DescribeTaskRequest describeTaskRequest) Provides information about a task, which defines where and how DataSync transfers your data.default DescribeTaskExecutionResponsedescribeTaskExecution(Consumer<DescribeTaskExecutionRequest.Builder> describeTaskExecutionRequest) Provides information about an execution of your DataSync task.default DescribeTaskExecutionResponsedescribeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest) Provides information about an execution of your DataSync task.default GenerateRecommendationsResponsegenerateRecommendations(Consumer<GenerateRecommendationsRequest.Builder> generateRecommendationsRequest) Creates recommendations about where to migrate your data to in Amazon Web Services.default GenerateRecommendationsResponsegenerateRecommendations(GenerateRecommendationsRequest generateRecommendationsRequest) Creates recommendations about where to migrate your data to in Amazon Web Services.default ListAgentsResponseReturns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.default ListAgentsResponselistAgents(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 ListAgentsResponselistAgents(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 ListAgentsIterableThis is a variant oflistAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)operation.default ListAgentsIterablelistAgentsPaginator(Consumer<ListAgentsRequest.Builder> listAgentsRequest) This is a variant oflistAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)operation.default ListAgentsIterablelistAgentsPaginator(ListAgentsRequest listAgentsRequest) This is a variant oflistAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)operation.default ListDiscoveryJobsResponselistDiscoveryJobs(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 ListDiscoveryJobsResponselistDiscoveryJobs(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 ListDiscoveryJobsIterablelistDiscoveryJobsPaginator(Consumer<ListDiscoveryJobsRequest.Builder> listDiscoveryJobsRequest) This is a variant oflistDiscoveryJobs(software.amazon.awssdk.services.datasync.model.ListDiscoveryJobsRequest)operation.default ListDiscoveryJobsIterablelistDiscoveryJobsPaginator(ListDiscoveryJobsRequest listDiscoveryJobsRequest) This is a variant oflistDiscoveryJobs(software.amazon.awssdk.services.datasync.model.ListDiscoveryJobsRequest)operation.default ListLocationsResponseReturns a list of source and destination locations.default ListLocationsResponselistLocations(Consumer<ListLocationsRequest.Builder> listLocationsRequest) Returns a list of source and destination locations.default ListLocationsResponselistLocations(ListLocationsRequest listLocationsRequest) Returns a list of source and destination locations.default ListLocationsIterableThis is a variant oflistLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)operation.default ListLocationsIterablelistLocationsPaginator(Consumer<ListLocationsRequest.Builder> listLocationsRequest) This is a variant oflistLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)operation.default ListLocationsIterablelistLocationsPaginator(ListLocationsRequest listLocationsRequest) This is a variant oflistLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)operation.default ListStorageSystemsResponselistStorageSystems(Consumer<ListStorageSystemsRequest.Builder> listStorageSystemsRequest) Lists the on-premises storage systems that you're using with DataSync Discovery.default ListStorageSystemsResponselistStorageSystems(ListStorageSystemsRequest listStorageSystemsRequest) Lists the on-premises storage systems that you're using with DataSync Discovery.default ListStorageSystemsIterablelistStorageSystemsPaginator(Consumer<ListStorageSystemsRequest.Builder> listStorageSystemsRequest) This is a variant oflistStorageSystems(software.amazon.awssdk.services.datasync.model.ListStorageSystemsRequest)operation.default ListStorageSystemsIterablelistStorageSystemsPaginator(ListStorageSystemsRequest listStorageSystemsRequest) This is a variant oflistStorageSystems(software.amazon.awssdk.services.datasync.model.ListStorageSystemsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns all the tags associated with an Amazon Web Services resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns all the tags associated with an Amazon Web Services resource.default ListTagsForResourceIterablelistTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest)operation.default ListTagsForResourceIterablelistTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest)operation.default ListTaskExecutionsResponseReturns a list of executions for an DataSync transfer task.default ListTaskExecutionsResponselistTaskExecutions(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest) Returns a list of executions for an DataSync transfer task.default ListTaskExecutionsResponselistTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest) Returns a list of executions for an DataSync transfer task.default ListTaskExecutionsIterableThis is a variant oflistTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)operation.default ListTaskExecutionsIterablelistTaskExecutionsPaginator(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest) This is a variant oflistTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)operation.default ListTaskExecutionsIterablelistTaskExecutionsPaginator(ListTaskExecutionsRequest listTaskExecutionsRequest) This is a variant oflistTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)operation.default ListTasksResponseReturns a list of the DataSync tasks you created.default ListTasksResponselistTasks(Consumer<ListTasksRequest.Builder> listTasksRequest) Returns a list of the DataSync tasks you created.default ListTasksResponselistTasks(ListTasksRequest listTasksRequest) Returns a list of the DataSync tasks you created.default ListTasksIterableThis is a variant oflistTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)operation.default ListTasksIterablelistTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest) This is a variant oflistTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)operation.default ListTasksIterablelistTasksPaginator(ListTasksRequest listTasksRequest) This is a variant oflistTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)operation.default RemoveStorageSystemResponseremoveStorageSystem(Consumer<RemoveStorageSystemRequest.Builder> removeStorageSystemRequest) Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.default RemoveStorageSystemResponseremoveStorageSystem(RemoveStorageSystemRequest removeStorageSystemRequest) Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault StartDiscoveryJobResponsestartDiscoveryJob(Consumer<StartDiscoveryJobRequest.Builder> startDiscoveryJobRequest) Runs a DataSync discovery job on your on-premises storage system.default StartDiscoveryJobResponsestartDiscoveryJob(StartDiscoveryJobRequest startDiscoveryJobRequest) Runs a DataSync discovery job on your on-premises storage system.default StartTaskExecutionResponsestartTaskExecution(Consumer<StartTaskExecutionRequest.Builder> startTaskExecutionRequest) Starts an DataSync transfer task.default StartTaskExecutionResponsestartTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest) Starts an DataSync transfer task.default StopDiscoveryJobResponsestopDiscoveryJob(Consumer<StopDiscoveryJobRequest.Builder> stopDiscoveryJobRequest) Stops a running DataSync discovery job.default StopDiscoveryJobResponsestopDiscoveryJob(StopDiscoveryJobRequest stopDiscoveryJobRequest) Stops a running DataSync discovery job.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies a tag to an Amazon Web Services resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) Applies a tag to an Amazon Web Services resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an Amazon Web Services resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) Removes tags from an Amazon Web Services resource.default UpdateAgentResponseupdateAgent(Consumer<UpdateAgentRequest.Builder> updateAgentRequest) Updates the name of an DataSync agent.default UpdateAgentResponseupdateAgent(UpdateAgentRequest updateAgentRequest) Updates the name of an DataSync agent.default UpdateDiscoveryJobResponseupdateDiscoveryJob(Consumer<UpdateDiscoveryJobRequest.Builder> updateDiscoveryJobRequest) Edits a DataSync discovery job configuration.default UpdateDiscoveryJobResponseupdateDiscoveryJob(UpdateDiscoveryJobRequest updateDiscoveryJobRequest) Edits a DataSync discovery job configuration.default UpdateLocationAzureBlobResponseupdateLocationAzureBlob(Consumer<UpdateLocationAzureBlobRequest.Builder> updateLocationAzureBlobRequest) Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.default UpdateLocationAzureBlobResponseupdateLocationAzureBlob(UpdateLocationAzureBlobRequest updateLocationAzureBlobRequest) Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.default UpdateLocationHdfsResponseupdateLocationHdfs(Consumer<UpdateLocationHdfsRequest.Builder> updateLocationHdfsRequest) Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.default UpdateLocationHdfsResponseupdateLocationHdfs(UpdateLocationHdfsRequest updateLocationHdfsRequest) Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.default UpdateLocationNfsResponseupdateLocationNfs(Consumer<UpdateLocationNfsRequest.Builder> updateLocationNfsRequest) Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.default UpdateLocationNfsResponseupdateLocationNfs(UpdateLocationNfsRequest updateLocationNfsRequest) Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.updateLocationObjectStorage(Consumer<UpdateLocationObjectStorageRequest.Builder> updateLocationObjectStorageRequest) Updates some parameters of an existing DataSync location for an object storage system.updateLocationObjectStorage(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest) Updates some parameters of an existing DataSync location for an object storage system.default UpdateLocationSmbResponseupdateLocationSmb(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 UpdateLocationSmbResponseupdateLocationSmb(UpdateLocationSmbRequest updateLocationSmbRequest) Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.default UpdateStorageSystemResponseupdateStorageSystem(Consumer<UpdateStorageSystemRequest.Builder> updateStorageSystemRequest) Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.default UpdateStorageSystemResponseupdateStorageSystem(UpdateStorageSystemRequest updateStorageSystemRequest) Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.default UpdateTaskResponseupdateTask(Consumer<UpdateTaskRequest.Builder> updateTaskRequest) Updates the configuration of a task, which defines where and how DataSync transfers your data.default UpdateTaskResponseupdateTask(UpdateTaskRequest updateTaskRequest) Updates the configuration of a task, which defines where and how DataSync transfers your data.default UpdateTaskExecutionResponseupdateTaskExecution(Consumer<UpdateTaskExecutionRequest.Builder> updateTaskExecutionRequest) Updates the configuration of a running DataSync task execution.default UpdateTaskExecutionResponseupdateTaskExecution(UpdateTaskExecutionRequest updateTaskExecutionRequest) Updates the configuration of a running DataSync task execution.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
addStorageSystem
default AddStorageSystemResponse addStorageSystem(AddStorageSystemRequest addStorageSystemRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
- Parameters:
addStorageSystemRequest-- Returns:
- Result of the AddStorageSystem operation returned by the service.
- See Also:
-
addStorageSystem
default AddStorageSystemResponse addStorageSystem(Consumer<AddStorageSystemRequest.Builder> addStorageSystemRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaAddStorageSystemRequest.builder()- Parameters:
addStorageSystemRequest- AConsumerthat will call methods onAddStorageSystemRequest.Builderto create a request.- Returns:
- Result of the AddStorageSystem operation returned by the service.
- See Also:
-
cancelTaskExecution
default CancelTaskExecutionResponse cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.
- Parameters:
cancelTaskExecutionRequest- CancelTaskExecutionRequest- Returns:
- Result of the CancelTaskExecution operation returned by the service.
- See Also:
-
cancelTaskExecution
default CancelTaskExecutionResponse cancelTaskExecution(Consumer<CancelTaskExecutionRequest.Builder> cancelTaskExecutionRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaCancelTaskExecutionRequest.builder()- Parameters:
cancelTaskExecutionRequest- AConsumerthat will call methods onCancelTaskExecutionRequest.Builderto create a request. CancelTaskExecutionRequest- Returns:
- Result of the CancelTaskExecution operation returned by the service.
- See Also:
-
createAgent
default CreateAgentResponse createAgent(CreateAgentRequest createAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.
- Parameters:
createAgentRequest- CreateAgentRequest- Returns:
- Result of the CreateAgent operation returned by the service.
- See Also:
-
createAgent
default CreateAgentResponse createAgent(Consumer<CreateAgentRequest.Builder> createAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaCreateAgentRequest.builder()- Parameters:
createAgentRequest- AConsumerthat will call methods onCreateAgentRequest.Builderto create a request. CreateAgentRequest- Returns:
- Result of the CreateAgent operation returned by the service.
- See Also:
-
createLocationAzureBlob
default CreateLocationAzureBlobResponse createLocationAzureBlob(CreateLocationAzureBlobRequest createLocationAzureBlobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location 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.
- Parameters:
createLocationAzureBlobRequest-- Returns:
- Result of the CreateLocationAzureBlob operation returned by the service.
- See Also:
-
createLocationAzureBlob
default CreateLocationAzureBlobResponse createLocationAzureBlob(Consumer<CreateLocationAzureBlobRequest.Builder> createLocationAzureBlobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location 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.Builderavoiding the need to create one manually viaCreateLocationAzureBlobRequest.builder()- Parameters:
createLocationAzureBlobRequest- AConsumerthat will call methods onCreateLocationAzureBlobRequest.Builderto create a request.- Returns:
- Result of the CreateLocationAzureBlob operation returned by the service.
- See Also:
-
createLocationEfs
default CreateLocationEfsResponse createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for an Amazon EFS file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses Amazon EFS file systems.
- Parameters:
createLocationEfsRequest- CreateLocationEfsRequest- Returns:
- Result of the CreateLocationEfs operation returned by the service.
- See Also:
-
createLocationEfs
default CreateLocationEfsResponse createLocationEfs(Consumer<CreateLocationEfsRequest.Builder> createLocationEfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for an Amazon EFS file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses Amazon EFS file systems.
This is a convenience which creates an instance of the
CreateLocationEfsRequest.Builderavoiding the need to create one manually viaCreateLocationEfsRequest.builder()- Parameters:
createLocationEfsRequest- AConsumerthat will call methods onCreateLocationEfsRequest.Builderto create a request. CreateLocationEfsRequest- Returns:
- Result of the CreateLocationEfs operation returned by the service.
- See Also:
-
createLocationFsxLustre
default CreateLocationFsxLustreResponse createLocationFsxLustre(CreateLocationFsxLustreRequest createLocationFsxLustreRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for an Amazon FSx for Lustre file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for Lustre file systems.
- Parameters:
createLocationFsxLustreRequest-- Returns:
- Result of the CreateLocationFsxLustre operation returned by the service.
- See Also:
-
createLocationFsxLustre
default CreateLocationFsxLustreResponse createLocationFsxLustre(Consumer<CreateLocationFsxLustreRequest.Builder> createLocationFsxLustreRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for an Amazon FSx for Lustre file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for Lustre file systems.
This is a convenience which creates an instance of the
CreateLocationFsxLustreRequest.Builderavoiding the need to create one manually viaCreateLocationFsxLustreRequest.builder()- Parameters:
createLocationFsxLustreRequest- AConsumerthat will call methods onCreateLocationFsxLustreRequest.Builderto create a request.- Returns:
- Result of the CreateLocationFsxLustre operation returned by the service.
- See Also:
-
createLocationFsxOntap
default CreateLocationFsxOntapResponse createLocationFsxOntap(CreateLocationFsxOntapRequest createLocationFsxOntapRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for an Amazon FSx for NetApp ONTAP file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for ONTAP file systems.
- Parameters:
createLocationFsxOntapRequest-- Returns:
- Result of the CreateLocationFsxOntap operation returned by the service.
- See Also:
-
createLocationFsxOntap
default CreateLocationFsxOntapResponse createLocationFsxOntap(Consumer<CreateLocationFsxOntapRequest.Builder> createLocationFsxOntapRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for an Amazon FSx for NetApp ONTAP file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for ONTAP file systems.
This is a convenience which creates an instance of the
CreateLocationFsxOntapRequest.Builderavoiding the need to create one manually viaCreateLocationFsxOntapRequest.builder()- Parameters:
createLocationFsxOntapRequest- AConsumerthat will call methods onCreateLocationFsxOntapRequest.Builderto create a request.- Returns:
- Result of the CreateLocationFsxOntap operation returned by the service.
- See Also:
-
createLocationFsxOpenZfs
default CreateLocationFsxOpenZfsResponse createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for an Amazon FSx for OpenZFS file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for OpenZFS file systems.
Request parameters related to
SMBaren't supported with theCreateLocationFsxOpenZfsoperation.- Parameters:
createLocationFsxOpenZfsRequest-- Returns:
- Result of the CreateLocationFsxOpenZfs operation returned by the service.
- See Also:
-
createLocationFsxOpenZfs
default CreateLocationFsxOpenZfsResponse createLocationFsxOpenZfs(Consumer<CreateLocationFsxOpenZfsRequest.Builder> createLocationFsxOpenZfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for an Amazon FSx for OpenZFS file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for OpenZFS file systems.
Request parameters related to
SMBaren't supported with theCreateLocationFsxOpenZfsoperation.
This is a convenience which creates an instance of the
CreateLocationFsxOpenZfsRequest.Builderavoiding the need to create one manually viaCreateLocationFsxOpenZfsRequest.builder()- Parameters:
createLocationFsxOpenZfsRequest- AConsumerthat will call methods onCreateLocationFsxOpenZfsRequest.Builderto create a request.- Returns:
- Result of the CreateLocationFsxOpenZfs operation returned by the service.
- See Also:
-
createLocationFsxWindows
default CreateLocationFsxWindowsResponse createLocationFsxWindows(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for Windows File Server file systems.
- Parameters:
createLocationFsxWindowsRequest-- Returns:
- Result of the CreateLocationFsxWindows operation returned by the service.
- See Also:
-
createLocationFsxWindows
default CreateLocationFsxWindowsResponse createLocationFsxWindows(Consumer<CreateLocationFsxWindowsRequest.Builder> createLocationFsxWindowsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for Windows File Server file systems.
This is a convenience which creates an instance of the
CreateLocationFsxWindowsRequest.Builderavoiding the need to create one manually viaCreateLocationFsxWindowsRequest.builder()- Parameters:
createLocationFsxWindowsRequest- AConsumerthat will call methods onCreateLocationFsxWindowsRequest.Builderto create a request.- Returns:
- Result of the CreateLocationFsxWindows operation returned by the service.
- See Also:
-
createLocationHdfs
default CreateLocationHdfsResponse createLocationHdfs(CreateLocationHdfsRequest createLocationHdfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses HDFS clusters.
- Parameters:
createLocationHdfsRequest-- Returns:
- Result of the CreateLocationHdfs operation returned by the service.
- See Also:
-
createLocationHdfs
default CreateLocationHdfsResponse createLocationHdfs(Consumer<CreateLocationHdfsRequest.Builder> createLocationHdfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses HDFS clusters.
This is a convenience which creates an instance of the
CreateLocationHdfsRequest.Builderavoiding the need to create one manually viaCreateLocationHdfsRequest.builder()- Parameters:
createLocationHdfsRequest- AConsumerthat will call methods onCreateLocationHdfsRequest.Builderto create a request.- Returns:
- Result of the CreateLocationHdfs operation returned by the service.
- See Also:
-
createLocationNfs
default CreateLocationNfsResponse createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for a Network File System (NFS) file server. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses NFS file servers.
If you're copying data to or from an Snowcone device, you can also use
CreateLocationNfsto create your transfer location. For more information, see Configuring transfers with Snowcone.- Parameters:
createLocationNfsRequest- CreateLocationNfsRequest- Returns:
- Result of the CreateLocationNfs operation returned by the service.
- See Also:
-
createLocationNfs
default CreateLocationNfsResponse createLocationNfs(Consumer<CreateLocationNfsRequest.Builder> createLocationNfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for a Network File System (NFS) file server. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses NFS file servers.
If you're copying data to or from an Snowcone device, you can also use
CreateLocationNfsto create your transfer location. For more information, see Configuring transfers with Snowcone.
This is a convenience which creates an instance of the
CreateLocationNfsRequest.Builderavoiding the need to create one manually viaCreateLocationNfsRequest.builder()- Parameters:
createLocationNfsRequest- AConsumerthat will call methods onCreateLocationNfsRequest.Builderto create a request. CreateLocationNfsRequest- Returns:
- Result of the CreateLocationNfs operation returned by the service.
- See Also:
-
createLocationObjectStorage
default CreateLocationObjectStorageResponse createLocationObjectStorage(CreateLocationObjectStorageRequest createLocationObjectStorageRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand the prerequisites for DataSync to work with object storage systems.
- Parameters:
createLocationObjectStorageRequest- CreateLocationObjectStorageRequest- Returns:
- Result of the CreateLocationObjectStorage operation returned by the service.
- See Also:
-
createLocationObjectStorage
default CreateLocationObjectStorageResponse createLocationObjectStorage(Consumer<CreateLocationObjectStorageRequest.Builder> createLocationObjectStorageRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand the prerequisites for DataSync to work with object storage systems.
This is a convenience which creates an instance of the
CreateLocationObjectStorageRequest.Builderavoiding the need to create one manually viaCreateLocationObjectStorageRequest.builder()- Parameters:
createLocationObjectStorageRequest- AConsumerthat will call methods onCreateLocationObjectStorageRequest.Builderto create a request. CreateLocationObjectStorageRequest- Returns:
- Result of the CreateLocationObjectStorage operation returned by the service.
- See Also:
-
createLocationS3
default CreateLocationS3Response createLocationS3(CreateLocationS3Request createLocationS3Request) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you read the following topics:
For more information, see Configuring transfers with Amazon S3.
- Parameters:
createLocationS3Request- CreateLocationS3Request- Returns:
- Result of the CreateLocationS3 operation returned by the service.
- See Also:
-
createLocationS3
default CreateLocationS3Response createLocationS3(Consumer<CreateLocationS3Request.Builder> createLocationS3Request) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you read the following topics:
For more information, see Configuring transfers with Amazon S3.
This is a convenience which creates an instance of the
CreateLocationS3Request.Builderavoiding the need to create one manually viaCreateLocationS3Request.builder()- Parameters:
createLocationS3Request- AConsumerthat will call methods onCreateLocationS3Request.Builderto create a request. CreateLocationS3Request- Returns:
- Result of the CreateLocationS3 operation returned by the service.
- See Also:
-
createLocationSmb
default CreateLocationSmbResponse createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses SMB file servers.
- Parameters:
createLocationSmbRequest- CreateLocationSmbRequest- Returns:
- Result of the CreateLocationSmb operation returned by the service.
- See Also:
-
createLocationSmb
default CreateLocationSmbResponse createLocationSmb(Consumer<CreateLocationSmbRequest.Builder> createLocationSmbRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Creates a transfer location for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses SMB file servers.
This is a convenience which creates an instance of the
CreateLocationSmbRequest.Builderavoiding the need to create one manually viaCreateLocationSmbRequest.builder()- Parameters:
createLocationSmbRequest- AConsumerthat will call methods onCreateLocationSmbRequest.Builderto create a request. CreateLocationSmbRequest- Returns:
- Result of the CreateLocationSmb operation returned by the service.
- See Also:
-
createTask
default CreateTaskResponse createTask(CreateTaskRequest createTaskRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Configures a task, which defines where and how DataSync transfers your data.
A task includes a source location, destination location, and transfer options (such as bandwidth limits, scheduling, and more).
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.
- Parameters:
createTaskRequest- CreateTaskRequest- Returns:
- Result of the CreateTask operation returned by the service.
- See Also:
-
createTask
default CreateTaskResponse createTask(Consumer<CreateTaskRequest.Builder> createTaskRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Configures a task, which defines where and how DataSync transfers your data.
A task includes a source location, destination location, and transfer options (such as bandwidth limits, scheduling, and more).
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.Builderavoiding the need to create one manually viaCreateTaskRequest.builder()- Parameters:
createTaskRequest- AConsumerthat will call methods onCreateTaskRequest.Builderto create a request. CreateTaskRequest- Returns:
- Result of the CreateTask operation returned by the service.
- See Also:
-
deleteAgent
default DeleteAgentResponse deleteAgent(DeleteAgentRequest deleteAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.
- Parameters:
deleteAgentRequest- DeleteAgentRequest- Returns:
- Result of the DeleteAgent operation returned by the service.
- See Also:
-
deleteAgent
default DeleteAgentResponse deleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaDeleteAgentRequest.builder()- Parameters:
deleteAgentRequest- AConsumerthat will call methods onDeleteAgentRequest.Builderto create a request. DeleteAgentRequest- Returns:
- Result of the DeleteAgent operation returned by the service.
- See Also:
-
deleteLocation
default DeleteLocationResponse deleteLocation(DeleteLocationRequest deleteLocationRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Deletes a transfer location resource from DataSync.
- Parameters:
deleteLocationRequest- DeleteLocation- Returns:
- Result of the DeleteLocation operation returned by the service.
- See Also:
-
deleteLocation
default DeleteLocationResponse deleteLocation(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Deletes a transfer location resource from DataSync.
This is a convenience which creates an instance of the
DeleteLocationRequest.Builderavoiding the need to create one manually viaDeleteLocationRequest.builder()- Parameters:
deleteLocationRequest- AConsumerthat will call methods onDeleteLocationRequest.Builderto create a request. DeleteLocation- Returns:
- Result of the DeleteLocation operation returned by the service.
- See Also:
-
deleteTask
default DeleteTaskResponse deleteTask(DeleteTaskRequest deleteTaskRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Deletes a transfer task resource from DataSync.
- Parameters:
deleteTaskRequest- DeleteTask- Returns:
- Result of the DeleteTask operation returned by the service.
- See Also:
-
deleteTask
default DeleteTaskResponse deleteTask(Consumer<DeleteTaskRequest.Builder> deleteTaskRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Deletes a transfer task resource from DataSync.
This is a convenience which creates an instance of the
DeleteTaskRequest.Builderavoiding the need to create one manually viaDeleteTaskRequest.builder()- Parameters:
deleteTaskRequest- AConsumerthat will call methods onDeleteTaskRequest.Builderto create a request. DeleteTask- Returns:
- Result of the DeleteTask operation returned by the service.
- See Also:
-
describeAgent
default DescribeAgentResponse describeAgent(DescribeAgentRequest describeAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Returns information about an DataSync agent, such as its name, service endpoint type, and status.
- Parameters:
describeAgentRequest- DescribeAgent- Returns:
- Result of the DescribeAgent operation returned by the service.
- See Also:
-
describeAgent
default DescribeAgentResponse describeAgent(Consumer<DescribeAgentRequest.Builder> describeAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaDescribeAgentRequest.builder()- Parameters:
describeAgentRequest- AConsumerthat will call methods onDescribeAgentRequest.Builderto create a request. DescribeAgent- Returns:
- Result of the DescribeAgent operation returned by the service.
- See Also:
-
describeDiscoveryJob
default DescribeDiscoveryJobResponse describeDiscoveryJob(DescribeDiscoveryJobRequest describeDiscoveryJobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Returns information about a DataSync discovery job.
- Parameters:
describeDiscoveryJobRequest-- Returns:
- Result of the DescribeDiscoveryJob operation returned by the service.
- See Also:
-
describeDiscoveryJob
default DescribeDiscoveryJobResponse describeDiscoveryJob(Consumer<DescribeDiscoveryJobRequest.Builder> describeDiscoveryJobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Returns information about a DataSync discovery job.
This is a convenience which creates an instance of the
DescribeDiscoveryJobRequest.Builderavoiding the need to create one manually viaDescribeDiscoveryJobRequest.builder()- Parameters:
describeDiscoveryJobRequest- AConsumerthat will call methods onDescribeDiscoveryJobRequest.Builderto create a request.- Returns:
- Result of the DescribeDiscoveryJob operation returned by the service.
- See Also:
-
describeLocationAzureBlob
default DescribeLocationAzureBlobResponse describeLocationAzureBlob(DescribeLocationAzureBlobRequest describeLocationAzureBlobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
- Parameters:
describeLocationAzureBlobRequest-- Returns:
- Result of the DescribeLocationAzureBlob operation returned by the service.
- See Also:
-
describeLocationAzureBlob
default DescribeLocationAzureBlobResponse describeLocationAzureBlob(Consumer<DescribeLocationAzureBlobRequest.Builder> describeLocationAzureBlobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaDescribeLocationAzureBlobRequest.builder()- Parameters:
describeLocationAzureBlobRequest- AConsumerthat will call methods onDescribeLocationAzureBlobRequest.Builderto create a request.- Returns:
- Result of the DescribeLocationAzureBlob operation returned by the service.
- See Also:
-
describeLocationEfs
default DescribeLocationEfsResponse describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.
- Parameters:
describeLocationEfsRequest- DescribeLocationEfsRequest- Returns:
- Result of the DescribeLocationEfs operation returned by the service.
- See Also:
-
describeLocationEfs
default DescribeLocationEfsResponse describeLocationEfs(Consumer<DescribeLocationEfsRequest.Builder> describeLocationEfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.
This is a convenience which creates an instance of the
DescribeLocationEfsRequest.Builderavoiding the need to create one manually viaDescribeLocationEfsRequest.builder()- Parameters:
describeLocationEfsRequest- AConsumerthat will call methods onDescribeLocationEfsRequest.Builderto create a request. DescribeLocationEfsRequest- Returns:
- Result of the DescribeLocationEfs operation returned by the service.
- See Also:
-
describeLocationFsxLustre
default DescribeLocationFsxLustreResponse describeLocationFsxLustre(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.
- Parameters:
describeLocationFsxLustreRequest-- Returns:
- Result of the DescribeLocationFsxLustre operation returned by the service.
- See Also:
-
describeLocationFsxLustre
default DescribeLocationFsxLustreResponse describeLocationFsxLustre(Consumer<DescribeLocationFsxLustreRequest.Builder> describeLocationFsxLustreRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.
This is a convenience which creates an instance of the
DescribeLocationFsxLustreRequest.Builderavoiding the need to create one manually viaDescribeLocationFsxLustreRequest.builder()- Parameters:
describeLocationFsxLustreRequest- AConsumerthat will call methods onDescribeLocationFsxLustreRequest.Builderto create a request.- Returns:
- Result of the DescribeLocationFsxLustre operation returned by the service.
- See Also:
-
describeLocationFsxOntap
default DescribeLocationFsxOntapResponse describeLocationFsxOntap(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.
If your location uses SMB, the
DescribeLocationFsxOntapoperation doesn't actually return aPassword.- Parameters:
describeLocationFsxOntapRequest-- Returns:
- Result of the DescribeLocationFsxOntap operation returned by the service.
- See Also:
-
describeLocationFsxOntap
default DescribeLocationFsxOntapResponse describeLocationFsxOntap(Consumer<DescribeLocationFsxOntapRequest.Builder> describeLocationFsxOntapRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.
If your location uses SMB, the
DescribeLocationFsxOntapoperation doesn't actually return aPassword.
This is a convenience which creates an instance of the
DescribeLocationFsxOntapRequest.Builderavoiding the need to create one manually viaDescribeLocationFsxOntapRequest.builder()- Parameters:
describeLocationFsxOntapRequest- AConsumerthat will call methods onDescribeLocationFsxOntapRequest.Builderto create a request.- Returns:
- Result of the DescribeLocationFsxOntap operation returned by the service.
- See Also:
-
describeLocationFsxOpenZfs
default DescribeLocationFsxOpenZfsResponse describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured.
Response elements related to
SMBaren't supported with theDescribeLocationFsxOpenZfsoperation.- Parameters:
describeLocationFsxOpenZfsRequest-- Returns:
- Result of the DescribeLocationFsxOpenZfs operation returned by the service.
- See Also:
-
describeLocationFsxOpenZfs
default DescribeLocationFsxOpenZfsResponse describeLocationFsxOpenZfs(Consumer<DescribeLocationFsxOpenZfsRequest.Builder> describeLocationFsxOpenZfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured.
Response elements related to
SMBaren't supported with theDescribeLocationFsxOpenZfsoperation.
This is a convenience which creates an instance of the
DescribeLocationFsxOpenZfsRequest.Builderavoiding the need to create one manually viaDescribeLocationFsxOpenZfsRequest.builder()- Parameters:
describeLocationFsxOpenZfsRequest- AConsumerthat will call methods onDescribeLocationFsxOpenZfsRequest.Builderto create a request.- Returns:
- Result of the DescribeLocationFsxOpenZfs operation returned by the service.
- See Also:
-
describeLocationFsxWindows
default DescribeLocationFsxWindowsResponse describeLocationFsxWindows(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.
- Parameters:
describeLocationFsxWindowsRequest-- Returns:
- Result of the DescribeLocationFsxWindows operation returned by the service.
- See Also:
-
describeLocationFsxWindows
default DescribeLocationFsxWindowsResponse describeLocationFsxWindows(Consumer<DescribeLocationFsxWindowsRequest.Builder> describeLocationFsxWindowsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.
This is a convenience which creates an instance of the
DescribeLocationFsxWindowsRequest.Builderavoiding the need to create one manually viaDescribeLocationFsxWindowsRequest.builder()- Parameters:
describeLocationFsxWindowsRequest- AConsumerthat will call methods onDescribeLocationFsxWindowsRequest.Builderto create a request.- Returns:
- Result of the DescribeLocationFsxWindows operation returned by the service.
- See Also:
-
describeLocationHdfs
default DescribeLocationHdfsResponse describeLocationHdfs(DescribeLocationHdfsRequest describeLocationHdfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.
- Parameters:
describeLocationHdfsRequest-- Returns:
- Result of the DescribeLocationHdfs operation returned by the service.
- See Also:
-
describeLocationHdfs
default DescribeLocationHdfsResponse describeLocationHdfs(Consumer<DescribeLocationHdfsRequest.Builder> describeLocationHdfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.
This is a convenience which creates an instance of the
DescribeLocationHdfsRequest.Builderavoiding the need to create one manually viaDescribeLocationHdfsRequest.builder()- Parameters:
describeLocationHdfsRequest- AConsumerthat will call methods onDescribeLocationHdfsRequest.Builderto create a request.- Returns:
- Result of the DescribeLocationHdfs operation returned by the service.
- See Also:
-
describeLocationNfs
default DescribeLocationNfsResponse describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.
- Parameters:
describeLocationNfsRequest- DescribeLocationNfsRequest- Returns:
- Result of the DescribeLocationNfs operation returned by the service.
- See Also:
-
describeLocationNfs
default DescribeLocationNfsResponse describeLocationNfs(Consumer<DescribeLocationNfsRequest.Builder> describeLocationNfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaDescribeLocationNfsRequest.builder()- Parameters:
describeLocationNfsRequest- AConsumerthat will call methods onDescribeLocationNfsRequest.Builderto create a request. DescribeLocationNfsRequest- Returns:
- Result of the DescribeLocationNfs operation returned by the service.
- See Also:
-
describeLocationObjectStorage
default DescribeLocationObjectStorageResponse describeLocationObjectStorage(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for an object storage system is configured.
- Parameters:
describeLocationObjectStorageRequest- DescribeLocationObjectStorageRequest- Returns:
- Result of the DescribeLocationObjectStorage operation returned by the service.
- See Also:
-
describeLocationObjectStorage
default DescribeLocationObjectStorageResponse describeLocationObjectStorage(Consumer<DescribeLocationObjectStorageRequest.Builder> describeLocationObjectStorageRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for an object storage system is configured.
This is a convenience which creates an instance of the
DescribeLocationObjectStorageRequest.Builderavoiding the need to create one manually viaDescribeLocationObjectStorageRequest.builder()- Parameters:
describeLocationObjectStorageRequest- AConsumerthat will call methods onDescribeLocationObjectStorageRequest.Builderto create a request. DescribeLocationObjectStorageRequest- Returns:
- Result of the DescribeLocationObjectStorage operation returned by the service.
- See Also:
-
describeLocationS3
default DescribeLocationS3Response describeLocationS3(DescribeLocationS3Request describeLocationS3Request) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for an S3 bucket is configured.
- Parameters:
describeLocationS3Request- DescribeLocationS3Request- Returns:
- Result of the DescribeLocationS3 operation returned by the service.
- See Also:
-
describeLocationS3
default DescribeLocationS3Response describeLocationS3(Consumer<DescribeLocationS3Request.Builder> describeLocationS3Request) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for an S3 bucket is configured.
This is a convenience which creates an instance of the
DescribeLocationS3Request.Builderavoiding the need to create one manually viaDescribeLocationS3Request.builder()- Parameters:
describeLocationS3Request- AConsumerthat will call methods onDescribeLocationS3Request.Builderto create a request. DescribeLocationS3Request- Returns:
- Result of the DescribeLocationS3 operation returned by the service.
- See Also:
-
describeLocationSmb
default DescribeLocationSmbResponse describeLocationSmb(DescribeLocationSmbRequest describeLocationSmbRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.
- Parameters:
describeLocationSmbRequest- DescribeLocationSmbRequest- Returns:
- Result of the DescribeLocationSmb operation returned by the service.
- See Also:
-
describeLocationSmb
default DescribeLocationSmbResponse describeLocationSmb(Consumer<DescribeLocationSmbRequest.Builder> describeLocationSmbRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.
This is a convenience which creates an instance of the
DescribeLocationSmbRequest.Builderavoiding the need to create one manually viaDescribeLocationSmbRequest.builder()- Parameters:
describeLocationSmbRequest- AConsumerthat will call methods onDescribeLocationSmbRequest.Builderto create a request. DescribeLocationSmbRequest- Returns:
- Result of the DescribeLocationSmb operation returned by the service.
- See Also:
-
describeStorageSystem
default DescribeStorageSystemResponse describeStorageSystem(DescribeStorageSystemRequest describeStorageSystemRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Returns information about an on-premises storage system that you're using with DataSync Discovery.
- Parameters:
describeStorageSystemRequest-- Returns:
- Result of the DescribeStorageSystem operation returned by the service.
- See Also:
-
describeStorageSystem
default DescribeStorageSystemResponse describeStorageSystem(Consumer<DescribeStorageSystemRequest.Builder> describeStorageSystemRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaDescribeStorageSystemRequest.builder()- Parameters:
describeStorageSystemRequest- AConsumerthat will call methods onDescribeStorageSystemRequest.Builderto create a request.- Returns:
- Result of the DescribeStorageSystem operation returned by the service.
- See Also:
-
describeStorageSystemResourceMetrics
default DescribeStorageSystemResourceMetricsResponse describeStorageSystemResourceMetrics(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
- Parameters:
describeStorageSystemResourceMetricsRequest-- Returns:
- Result of the DescribeStorageSystemResourceMetrics operation returned by the service.
- See Also:
-
describeStorageSystemResourceMetrics
default DescribeStorageSystemResourceMetricsResponse describeStorageSystemResourceMetrics(Consumer<DescribeStorageSystemResourceMetricsRequest.Builder> describeStorageSystemResourceMetricsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaDescribeStorageSystemResourceMetricsRequest.builder()- Parameters:
describeStorageSystemResourceMetricsRequest- AConsumerthat will call methods onDescribeStorageSystemResourceMetricsRequest.Builderto create a request.- Returns:
- Result of the DescribeStorageSystemResourceMetrics operation returned by the service.
- See Also:
-
describeStorageSystemResourceMetricsPaginator
default DescribeStorageSystemResourceMetricsIterable describeStorageSystemResourceMetricsPaginator(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
describeStorageSystemResourceMetrics(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourceMetricsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourceMetricsIterable responses = client.describeStorageSystemResourceMetricsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourceMetricsIterable responses = client .describeStorageSystemResourceMetricsPaginator(request); for (software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourceMetricsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourceMetricsIterable responses = client.describeStorageSystemResourceMetricsPaginator(request); responses.iterator().forEachRemaining(....);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.- Parameters:
describeStorageSystemResourceMetricsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeStorageSystemResourceMetricsPaginator
default DescribeStorageSystemResourceMetricsIterable describeStorageSystemResourceMetricsPaginator(Consumer<DescribeStorageSystemResourceMetricsRequest.Builder> describeStorageSystemResourceMetricsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
describeStorageSystemResourceMetrics(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourceMetricsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourceMetricsIterable responses = client.describeStorageSystemResourceMetricsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourceMetricsIterable responses = client .describeStorageSystemResourceMetricsPaginator(request); for (software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourceMetricsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourceMetricsIterable responses = client.describeStorageSystemResourceMetricsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeStorageSystemResourceMetricsRequest.builder()- Parameters:
describeStorageSystemResourceMetricsRequest- AConsumerthat will call methods onDescribeStorageSystemResourceMetricsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeStorageSystemResources
default DescribeStorageSystemResourcesResponse describeStorageSystemResources(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Returns information that DataSync Discovery collects about resources in your on-premises storage system.
- Parameters:
describeStorageSystemResourcesRequest-- Returns:
- Result of the DescribeStorageSystemResources operation returned by the service.
- See Also:
-
describeStorageSystemResources
default DescribeStorageSystemResourcesResponse describeStorageSystemResources(Consumer<DescribeStorageSystemResourcesRequest.Builder> describeStorageSystemResourcesRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaDescribeStorageSystemResourcesRequest.builder()- Parameters:
describeStorageSystemResourcesRequest- AConsumerthat will call methods onDescribeStorageSystemResourcesRequest.Builderto create a request.- Returns:
- Result of the DescribeStorageSystemResources operation returned by the service.
- See Also:
-
describeStorageSystemResourcesPaginator
default DescribeStorageSystemResourcesIterable describeStorageSystemResourcesPaginator(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
describeStorageSystemResources(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourcesIterable responses = client.describeStorageSystemResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourcesIterable responses = client .describeStorageSystemResourcesPaginator(request); for (software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourcesIterable responses = client.describeStorageSystemResourcesPaginator(request); responses.iterator().forEachRemaining(....);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.- Parameters:
describeStorageSystemResourcesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeStorageSystemResourcesPaginator
default DescribeStorageSystemResourcesIterable describeStorageSystemResourcesPaginator(Consumer<DescribeStorageSystemResourcesRequest.Builder> describeStorageSystemResourcesRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
describeStorageSystemResources(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourcesIterable responses = client.describeStorageSystemResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourcesIterable responses = client .describeStorageSystemResourcesPaginator(request); for (software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourcesIterable responses = client.describeStorageSystemResourcesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeStorageSystemResourcesRequest.builder()- Parameters:
describeStorageSystemResourcesRequest- AConsumerthat will call methods onDescribeStorageSystemResourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTask
default DescribeTaskResponse describeTask(DescribeTaskRequest describeTaskRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides information about a task, which defines where and how DataSync transfers your data.
- Parameters:
describeTaskRequest- DescribeTaskRequest- Returns:
- Result of the DescribeTask operation returned by the service.
- See Also:
-
describeTask
default DescribeTaskResponse describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Provides information about a task, which defines where and how DataSync transfers your data.
This is a convenience which creates an instance of the
DescribeTaskRequest.Builderavoiding the need to create one manually viaDescribeTaskRequest.builder()- Parameters:
describeTaskRequest- AConsumerthat will call methods onDescribeTaskRequest.Builderto create a request. DescribeTaskRequest- Returns:
- Result of the DescribeTask operation returned by the service.
- See Also:
-
describeTaskExecution
default DescribeTaskExecutionResponse describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.
- Parameters:
describeTaskExecutionRequest- DescribeTaskExecutionRequest- Returns:
- Result of the DescribeTaskExecution operation returned by the service.
- See Also:
-
describeTaskExecution
default DescribeTaskExecutionResponse describeTaskExecution(Consumer<DescribeTaskExecutionRequest.Builder> describeTaskExecutionRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaDescribeTaskExecutionRequest.builder()- Parameters:
describeTaskExecutionRequest- AConsumerthat will call methods onDescribeTaskExecutionRequest.Builderto create a request. DescribeTaskExecutionRequest- Returns:
- Result of the DescribeTaskExecution operation returned by the service.
- See Also:
-
generateRecommendations
default GenerateRecommendationsResponse generateRecommendations(GenerateRecommendationsRequest generateRecommendationsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.
- Parameters:
generateRecommendationsRequest-- Returns:
- Result of the GenerateRecommendations operation returned by the service.
- See Also:
-
generateRecommendations
default GenerateRecommendationsResponse generateRecommendations(Consumer<GenerateRecommendationsRequest.Builder> generateRecommendationsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaGenerateRecommendationsRequest.builder()- Parameters:
generateRecommendationsRequest- AConsumerthat will call methods onGenerateRecommendationsRequest.Builderto create a request.- Returns:
- Result of the GenerateRecommendations operation returned by the service.
- See Also:
-
listAgents
default ListAgentsResponse listAgents(ListAgentsRequest listAgentsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.
ListAgentsis 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 runListAgents, 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.- Parameters:
listAgentsRequest- ListAgentsRequest- Returns:
- Result of the ListAgents operation returned by the service.
- See Also:
-
listAgents
default ListAgentsResponse listAgents(Consumer<ListAgentsRequest.Builder> listAgentsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.
ListAgentsis 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 runListAgents, 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.Builderavoiding the need to create one manually viaListAgentsRequest.builder()- Parameters:
listAgentsRequest- AConsumerthat will call methods onListAgentsRequest.Builderto create a request. ListAgentsRequest- Returns:
- Result of the ListAgents operation returned by the service.
- See Also:
-
listAgents
default ListAgentsResponse listAgents() throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncExceptionReturns 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.
ListAgentsis 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 runListAgents, 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.- Returns:
- Result of the ListAgents operation returned by the service.
- See Also:
-
listAgentsPaginator
default ListAgentsIterable listAgentsPaginator() throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncExceptionThis is a variant of
listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListAgentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); responses.iterator().forEachRemaining(....);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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAgentsPaginator
default ListAgentsIterable listAgentsPaginator(ListAgentsRequest listAgentsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListAgentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); responses.iterator().forEachRemaining(....);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.- Parameters:
listAgentsRequest- ListAgentsRequest- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAgentsPaginator
default ListAgentsIterable listAgentsPaginator(Consumer<ListAgentsRequest.Builder> listAgentsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListAgentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListAgentsRequest.builder()- Parameters:
listAgentsRequest- AConsumerthat will call methods onListAgentsRequest.Builderto create a request. ListAgentsRequest- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDiscoveryJobs
default ListDiscoveryJobsResponse listDiscoveryJobs(ListDiscoveryJobsRequest listDiscoveryJobsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.
- Parameters:
listDiscoveryJobsRequest-- Returns:
- Result of the ListDiscoveryJobs operation returned by the service.
- See Also:
-
listDiscoveryJobs
default ListDiscoveryJobsResponse listDiscoveryJobs(Consumer<ListDiscoveryJobsRequest.Builder> listDiscoveryJobsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaListDiscoveryJobsRequest.builder()- Parameters:
listDiscoveryJobsRequest- AConsumerthat will call methods onListDiscoveryJobsRequest.Builderto create a request.- Returns:
- Result of the ListDiscoveryJobs operation returned by the service.
- See Also:
-
listDiscoveryJobsPaginator
default ListDiscoveryJobsIterable listDiscoveryJobsPaginator(ListDiscoveryJobsRequest listDiscoveryJobsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
listDiscoveryJobs(software.amazon.awssdk.services.datasync.model.ListDiscoveryJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListDiscoveryJobsIterable responses = client.listDiscoveryJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListDiscoveryJobsIterable responses = client .listDiscoveryJobsPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListDiscoveryJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListDiscoveryJobsIterable responses = client.listDiscoveryJobsPaginator(request); responses.iterator().forEachRemaining(....);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.- Parameters:
listDiscoveryJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDiscoveryJobsPaginator
default ListDiscoveryJobsIterable listDiscoveryJobsPaginator(Consumer<ListDiscoveryJobsRequest.Builder> listDiscoveryJobsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
listDiscoveryJobs(software.amazon.awssdk.services.datasync.model.ListDiscoveryJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListDiscoveryJobsIterable responses = client.listDiscoveryJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListDiscoveryJobsIterable responses = client .listDiscoveryJobsPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListDiscoveryJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListDiscoveryJobsIterable responses = client.listDiscoveryJobsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListDiscoveryJobsRequest.builder()- Parameters:
listDiscoveryJobsRequest- AConsumerthat will call methods onListDiscoveryJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLocations
default ListLocationsResponse listLocations(ListLocationsRequest listLocationsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.
- Parameters:
listLocationsRequest- ListLocationsRequest- Returns:
- Result of the ListLocations operation returned by the service.
- See Also:
-
listLocations
default ListLocationsResponse listLocations(Consumer<ListLocationsRequest.Builder> listLocationsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaListLocationsRequest.builder()- Parameters:
listLocationsRequest- AConsumerthat will call methods onListLocationsRequest.Builderto create a request. ListLocationsRequest- Returns:
- Result of the ListLocations operation returned by the service.
- See Also:
-
listLocations
default ListLocationsResponse listLocations() throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncExceptionReturns 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.
- Returns:
- Result of the ListLocations operation returned by the service.
- See Also:
-
listLocationsPaginator
default ListLocationsIterable listLocationsPaginator() throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncExceptionThis is a variant of
listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListLocationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request); responses.iterator().forEachRemaining(....);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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLocationsPaginator
default ListLocationsIterable listLocationsPaginator(ListLocationsRequest listLocationsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListLocationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request); responses.iterator().forEachRemaining(....);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.- Parameters:
listLocationsRequest- ListLocationsRequest- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLocationsPaginator
default ListLocationsIterable listLocationsPaginator(Consumer<ListLocationsRequest.Builder> listLocationsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListLocationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListLocationsRequest.builder()- Parameters:
listLocationsRequest- AConsumerthat will call methods onListLocationsRequest.Builderto create a request. ListLocationsRequest- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStorageSystems
default ListStorageSystemsResponse listStorageSystems(ListStorageSystemsRequest listStorageSystemsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Lists the on-premises storage systems that you're using with DataSync Discovery.
- Parameters:
listStorageSystemsRequest-- Returns:
- Result of the ListStorageSystems operation returned by the service.
- See Also:
-
listStorageSystems
default ListStorageSystemsResponse listStorageSystems(Consumer<ListStorageSystemsRequest.Builder> listStorageSystemsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Lists the on-premises storage systems that you're using with DataSync Discovery.
This is a convenience which creates an instance of the
ListStorageSystemsRequest.Builderavoiding the need to create one manually viaListStorageSystemsRequest.builder()- Parameters:
listStorageSystemsRequest- AConsumerthat will call methods onListStorageSystemsRequest.Builderto create a request.- Returns:
- Result of the ListStorageSystems operation returned by the service.
- See Also:
-
listStorageSystemsPaginator
default ListStorageSystemsIterable listStorageSystemsPaginator(ListStorageSystemsRequest listStorageSystemsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
listStorageSystems(software.amazon.awssdk.services.datasync.model.ListStorageSystemsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListStorageSystemsIterable responses = client.listStorageSystemsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListStorageSystemsIterable responses = client .listStorageSystemsPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListStorageSystemsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListStorageSystemsIterable responses = client.listStorageSystemsPaginator(request); responses.iterator().forEachRemaining(....);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.- Parameters:
listStorageSystemsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStorageSystemsPaginator
default ListStorageSystemsIterable listStorageSystemsPaginator(Consumer<ListStorageSystemsRequest.Builder> listStorageSystemsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
listStorageSystems(software.amazon.awssdk.services.datasync.model.ListStorageSystemsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListStorageSystemsIterable responses = client.listStorageSystemsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListStorageSystemsIterable responses = client .listStorageSystemsPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListStorageSystemsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListStorageSystemsIterable responses = client.listStorageSystemsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListStorageSystemsRequest.builder()- Parameters:
listStorageSystemsRequest- AConsumerthat will call methods onListStorageSystemsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Returns all the tags associated with an Amazon Web Services resource.
- Parameters:
listTagsForResourceRequest- ListTagsForResourceRequest- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Returns all the tags associated with an Amazon Web Services resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request. ListTagsForResourceRequest- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.datasync.model.ListTagsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);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.- Parameters:
listTagsForResourceRequest- ListTagsForResourceRequest- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.datasync.model.ListTagsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request. ListTagsForResourceRequest- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTaskExecutions
default ListTaskExecutionsResponse listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Returns a list of executions for an DataSync transfer task.
- Parameters:
listTaskExecutionsRequest- ListTaskExecutions- Returns:
- Result of the ListTaskExecutions operation returned by the service.
- See Also:
-
listTaskExecutions
default ListTaskExecutionsResponse listTaskExecutions(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Returns a list of executions for an DataSync transfer task.
This is a convenience which creates an instance of the
ListTaskExecutionsRequest.Builderavoiding the need to create one manually viaListTaskExecutionsRequest.builder()- Parameters:
listTaskExecutionsRequest- AConsumerthat will call methods onListTaskExecutionsRequest.Builderto create a request. ListTaskExecutions- Returns:
- Result of the ListTaskExecutions operation returned by the service.
- See Also:
-
listTaskExecutions
default ListTaskExecutionsResponse listTaskExecutions() throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncExceptionReturns a list of executions for an DataSync transfer task.
- Returns:
- Result of the ListTaskExecutions operation returned by the service.
- See Also:
-
listTaskExecutionsPaginator
default ListTaskExecutionsIterable listTaskExecutionsPaginator() throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncExceptionThis is a variant of
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client .listTaskExecutionsPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request); responses.iterator().forEachRemaining(....);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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTaskExecutionsPaginator
default ListTaskExecutionsIterable listTaskExecutionsPaginator(ListTaskExecutionsRequest listTaskExecutionsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client .listTaskExecutionsPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request); responses.iterator().forEachRemaining(....);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.- Parameters:
listTaskExecutionsRequest- ListTaskExecutions- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTaskExecutionsPaginator
default ListTaskExecutionsIterable listTaskExecutionsPaginator(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client .listTaskExecutionsPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListTaskExecutionsRequest.builder()- Parameters:
listTaskExecutionsRequest- AConsumerthat will call methods onListTaskExecutionsRequest.Builderto create a request. ListTaskExecutions- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTasks
default ListTasksResponse listTasks(ListTasksRequest listTasksRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Returns a list of the DataSync tasks you created.
- Parameters:
listTasksRequest- ListTasksRequest- Returns:
- Result of the ListTasks operation returned by the service.
- See Also:
-
listTasks
default ListTasksResponse listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Returns a list of the DataSync tasks you created.
This is a convenience which creates an instance of the
ListTasksRequest.Builderavoiding the need to create one manually viaListTasksRequest.builder()- Parameters:
listTasksRequest- AConsumerthat will call methods onListTasksRequest.Builderto create a request. ListTasksRequest- Returns:
- Result of the ListTasks operation returned by the service.
- See Also:
-
listTasks
default ListTasksResponse listTasks() throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncExceptionReturns a list of the DataSync tasks you created.
- Returns:
- Result of the ListTasks operation returned by the service.
- See Also:
-
listTasksPaginator
default ListTasksIterable listTasksPaginator() throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncExceptionThis is a variant of
listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListTasksResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.iterator().forEachRemaining(....);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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTasksPaginator
default ListTasksIterable listTasksPaginator(ListTasksRequest listTasksRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListTasksResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.iterator().forEachRemaining(....);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.- Parameters:
listTasksRequest- ListTasksRequest- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTasksPaginator
default ListTasksIterable listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException This is a variant of
listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request); for (software.amazon.awssdk.services.datasync.model.ListTasksResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListTasksRequest.builder()- Parameters:
listTasksRequest- AConsumerthat will call methods onListTasksRequest.Builderto create a request. ListTasksRequest- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
removeStorageSystem
default RemoveStorageSystemResponse removeStorageSystem(RemoveStorageSystemRequest removeStorageSystemRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.
- Parameters:
removeStorageSystemRequest-- Returns:
- Result of the RemoveStorageSystem operation returned by the service.
- See Also:
-
removeStorageSystem
default RemoveStorageSystemResponse removeStorageSystem(Consumer<RemoveStorageSystemRequest.Builder> removeStorageSystemRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaRemoveStorageSystemRequest.builder()- Parameters:
removeStorageSystemRequest- AConsumerthat will call methods onRemoveStorageSystemRequest.Builderto create a request.- Returns:
- Result of the RemoveStorageSystem operation returned by the service.
- See Also:
-
startDiscoveryJob
default StartDiscoveryJobResponse startDiscoveryJob(StartDiscoveryJobRequest startDiscoveryJobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.
- Parameters:
startDiscoveryJobRequest-- Returns:
- Result of the StartDiscoveryJob operation returned by the service.
- See Also:
-
startDiscoveryJob
default StartDiscoveryJobResponse startDiscoveryJob(Consumer<StartDiscoveryJobRequest.Builder> startDiscoveryJobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaStartDiscoveryJobRequest.builder()- Parameters:
startDiscoveryJobRequest- AConsumerthat will call methods onStartDiscoveryJobRequest.Builderto create a request.- Returns:
- Result of the StartDiscoveryJob operation returned by the service.
- See Also:
-
startTaskExecution
default StartTaskExecutionResponse startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.
- Parameters:
startTaskExecutionRequest- StartTaskExecutionRequest- Returns:
- Result of the StartTaskExecution operation returned by the service.
- See Also:
-
startTaskExecution
default StartTaskExecutionResponse startTaskExecution(Consumer<StartTaskExecutionRequest.Builder> startTaskExecutionRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaStartTaskExecutionRequest.builder()- Parameters:
startTaskExecutionRequest- AConsumerthat will call methods onStartTaskExecutionRequest.Builderto create a request. StartTaskExecutionRequest- Returns:
- Result of the StartTaskExecution operation returned by the service.
- See Also:
-
stopDiscoveryJob
default StopDiscoveryJobResponse stopDiscoveryJob(StopDiscoveryJobRequest stopDiscoveryJobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.
- Parameters:
stopDiscoveryJobRequest-- Returns:
- Result of the StopDiscoveryJob operation returned by the service.
- See Also:
-
stopDiscoveryJob
default StopDiscoveryJobResponse stopDiscoveryJob(Consumer<StopDiscoveryJobRequest.Builder> stopDiscoveryJobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaStopDiscoveryJobRequest.builder()- Parameters:
stopDiscoveryJobRequest- AConsumerthat will call methods onStopDiscoveryJobRequest.Builderto create a request.- Returns:
- Result of the StopDiscoveryJob operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.
- Parameters:
tagResourceRequest- TagResourceRequest- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request. TagResourceRequest- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Removes tags from an Amazon Web Services resource.
- Parameters:
untagResourceRequest- UntagResourceRequest- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Removes tags from an Amazon Web Services resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request. UntagResourceRequest- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAgent
default UpdateAgentResponse updateAgent(UpdateAgentRequest updateAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Updates the name of an DataSync agent.
- Parameters:
updateAgentRequest- UpdateAgentRequest- Returns:
- Result of the UpdateAgent operation returned by the service.
- See Also:
-
updateAgent
default UpdateAgentResponse updateAgent(Consumer<UpdateAgentRequest.Builder> updateAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Updates the name of an DataSync agent.
This is a convenience which creates an instance of the
UpdateAgentRequest.Builderavoiding the need to create one manually viaUpdateAgentRequest.builder()- Parameters:
updateAgentRequest- AConsumerthat will call methods onUpdateAgentRequest.Builderto create a request. UpdateAgentRequest- Returns:
- Result of the UpdateAgent operation returned by the service.
- See Also:
-
updateDiscoveryJob
default UpdateDiscoveryJobResponse updateDiscoveryJob(UpdateDiscoveryJobRequest updateDiscoveryJobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Edits a DataSync discovery job configuration.
- Parameters:
updateDiscoveryJobRequest-- Returns:
- Result of the UpdateDiscoveryJob operation returned by the service.
- See Also:
-
updateDiscoveryJob
default UpdateDiscoveryJobResponse updateDiscoveryJob(Consumer<UpdateDiscoveryJobRequest.Builder> updateDiscoveryJobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Edits a DataSync discovery job configuration.
This is a convenience which creates an instance of the
UpdateDiscoveryJobRequest.Builderavoiding the need to create one manually viaUpdateDiscoveryJobRequest.builder()- Parameters:
updateDiscoveryJobRequest- AConsumerthat will call methods onUpdateDiscoveryJobRequest.Builderto create a request.- Returns:
- Result of the UpdateDiscoveryJob operation returned by the service.
- See Also:
-
updateLocationAzureBlob
default UpdateLocationAzureBlobResponse updateLocationAzureBlob(UpdateLocationAzureBlobRequest updateLocationAzureBlobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
- Parameters:
updateLocationAzureBlobRequest-- Returns:
- Result of the UpdateLocationAzureBlob operation returned by the service.
- See Also:
-
updateLocationAzureBlob
default UpdateLocationAzureBlobResponse updateLocationAzureBlob(Consumer<UpdateLocationAzureBlobRequest.Builder> updateLocationAzureBlobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaUpdateLocationAzureBlobRequest.builder()- Parameters:
updateLocationAzureBlobRequest- AConsumerthat will call methods onUpdateLocationAzureBlobRequest.Builderto create a request.- Returns:
- Result of the UpdateLocationAzureBlob operation returned by the service.
- See Also:
-
updateLocationHdfs
default UpdateLocationHdfsResponse updateLocationHdfs(UpdateLocationHdfsRequest updateLocationHdfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
- Parameters:
updateLocationHdfsRequest-- Returns:
- Result of the UpdateLocationHdfs operation returned by the service.
- See Also:
-
updateLocationHdfs
default UpdateLocationHdfsResponse updateLocationHdfs(Consumer<UpdateLocationHdfsRequest.Builder> updateLocationHdfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaUpdateLocationHdfsRequest.builder()- Parameters:
updateLocationHdfsRequest- AConsumerthat will call methods onUpdateLocationHdfsRequest.Builderto create a request.- Returns:
- Result of the UpdateLocationHdfs operation returned by the service.
- See Also:
-
updateLocationNfs
default UpdateLocationNfsResponse updateLocationNfs(UpdateLocationNfsRequest updateLocationNfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.
- Parameters:
updateLocationNfsRequest-- Returns:
- Result of the UpdateLocationNfs operation returned by the service.
- See Also:
-
updateLocationNfs
default UpdateLocationNfsResponse updateLocationNfs(Consumer<UpdateLocationNfsRequest.Builder> updateLocationNfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaUpdateLocationNfsRequest.builder()- Parameters:
updateLocationNfsRequest- AConsumerthat will call methods onUpdateLocationNfsRequest.Builderto create a request.- Returns:
- Result of the UpdateLocationNfs operation returned by the service.
- See Also:
-
updateLocationObjectStorage
default UpdateLocationObjectStorageResponse updateLocationObjectStorage(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Updates some parameters of an existing DataSync location for an object storage system.
- Parameters:
updateLocationObjectStorageRequest-- Returns:
- Result of the UpdateLocationObjectStorage operation returned by the service.
- See Also:
-
updateLocationObjectStorage
default UpdateLocationObjectStorageResponse updateLocationObjectStorage(Consumer<UpdateLocationObjectStorageRequest.Builder> updateLocationObjectStorageRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Updates some parameters of an existing DataSync location for an object storage system.
This is a convenience which creates an instance of the
UpdateLocationObjectStorageRequest.Builderavoiding the need to create one manually viaUpdateLocationObjectStorageRequest.builder()- Parameters:
updateLocationObjectStorageRequest- AConsumerthat will call methods onUpdateLocationObjectStorageRequest.Builderto create a request.- Returns:
- Result of the UpdateLocationObjectStorage operation returned by the service.
- See Also:
-
updateLocationSmb
default UpdateLocationSmbResponse updateLocationSmb(UpdateLocationSmbRequest updateLocationSmbRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.
- Parameters:
updateLocationSmbRequest-- Returns:
- Result of the UpdateLocationSmb operation returned by the service.
- See Also:
-
updateLocationSmb
default UpdateLocationSmbResponse updateLocationSmb(Consumer<UpdateLocationSmbRequest.Builder> updateLocationSmbRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaUpdateLocationSmbRequest.builder()- Parameters:
updateLocationSmbRequest- AConsumerthat will call methods onUpdateLocationSmbRequest.Builderto create a request.- Returns:
- Result of the UpdateLocationSmb operation returned by the service.
- See Also:
-
updateStorageSystem
default UpdateStorageSystemResponse updateStorageSystem(UpdateStorageSystemRequest updateStorageSystemRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
- Parameters:
updateStorageSystemRequest-- Returns:
- Result of the UpdateStorageSystem operation returned by the service.
- See Also:
-
updateStorageSystem
default UpdateStorageSystemResponse updateStorageSystem(Consumer<UpdateStorageSystemRequest.Builder> updateStorageSystemRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException 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.Builderavoiding the need to create one manually viaUpdateStorageSystemRequest.builder()- Parameters:
updateStorageSystemRequest- AConsumerthat will call methods onUpdateStorageSystemRequest.Builderto create a request.- Returns:
- Result of the UpdateStorageSystem operation returned by the service.
- See Also:
-
updateTask
default UpdateTaskResponse updateTask(UpdateTaskRequest updateTaskRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Updates the configuration of a task, which defines where and how DataSync transfers your data.
- Parameters:
updateTaskRequest- UpdateTaskResponse- Returns:
- Result of the UpdateTask operation returned by the service.
- See Also:
-
updateTask
default UpdateTaskResponse updateTask(Consumer<UpdateTaskRequest.Builder> updateTaskRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Updates the configuration of a task, which defines where and how DataSync transfers your data.
This is a convenience which creates an instance of the
UpdateTaskRequest.Builderavoiding the need to create one manually viaUpdateTaskRequest.builder()- Parameters:
updateTaskRequest- AConsumerthat will call methods onUpdateTaskRequest.Builderto create a request. UpdateTaskResponse- Returns:
- Result of the UpdateTask operation returned by the service.
- See Also:
-
updateTaskExecution
default UpdateTaskExecutionResponse updateTaskExecution(UpdateTaskExecutionRequest updateTaskExecutionRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Updates the configuration of a running DataSync task execution.
Currently, the only
Optionthat you can modify withUpdateTaskExecutionisBytesPerSecond, which throttles bandwidth for a running or queued task execution.- Parameters:
updateTaskExecutionRequest-- Returns:
- Result of the UpdateTaskExecution operation returned by the service.
- See Also:
-
updateTaskExecution
default UpdateTaskExecutionResponse updateTaskExecution(Consumer<UpdateTaskExecutionRequest.Builder> updateTaskExecutionRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException Updates the configuration of a running DataSync task execution.
Currently, the only
Optionthat you can modify withUpdateTaskExecutionisBytesPerSecond, which throttles bandwidth for a running or queued task execution.
This is a convenience which creates an instance of the
UpdateTaskExecutionRequest.Builderavoiding the need to create one manually viaUpdateTaskExecutionRequest.builder()- Parameters:
updateTaskExecutionRequest- AConsumerthat will call methods onUpdateTaskExecutionRequest.Builderto create a request.- Returns:
- Result of the UpdateTaskExecution operation returned by the service.
- See Also:
-
create
Create aDataSyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aDataSyncClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-