@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface DataSyncClient extends AwsClient
builder() method.
DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Web Services storage services. You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.
This API interface reference includes documentation for using DataSync programmatically. For complete information, see the DataSync User Guide .
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AddStorageSystemResponse |
addStorageSystem(AddStorageSystemRequest addStorageSystemRequest)
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to
collect information about.
|
default AddStorageSystemResponse |
addStorageSystem(Consumer<AddStorageSystemRequest.Builder> addStorageSystemRequest)
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to
collect information about.
|
static DataSyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
DataSyncClient. |
default CancelTaskExecutionResponse |
cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)
Stops an DataSync task execution that's in progress.
|
default CancelTaskExecutionResponse |
cancelTaskExecution(Consumer<CancelTaskExecutionRequest.Builder> cancelTaskExecutionRequest)
Stops an DataSync task execution that's in progress.
|
static DataSyncClient |
create()
Create a
DataSyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAgentResponse |
createAgent(Consumer<CreateAgentRequest.Builder> createAgentRequest)
Activates an DataSync agent that you have deployed in your storage environment.
|
default CreateAgentResponse |
createAgent(CreateAgentRequest createAgentRequest)
Activates an DataSync agent that you have deployed in your storage environment.
|
default CreateLocationEfsResponse |
createLocationEfs(Consumer<CreateLocationEfsRequest.Builder> createLocationEfsRequest)
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer.
|
default CreateLocationEfsResponse |
createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer.
|
default CreateLocationFsxLustreResponse |
createLocationFsxLustre(Consumer<CreateLocationFsxLustreRequest.Builder> createLocationFsxLustreRequest)
Creates an endpoint for an Amazon FSx for Lustre file system.
|
default CreateLocationFsxLustreResponse |
createLocationFsxLustre(CreateLocationFsxLustreRequest createLocationFsxLustreRequest)
Creates an endpoint for an Amazon FSx for Lustre file system.
|
default CreateLocationFsxOntapResponse |
createLocationFsxOntap(Consumer<CreateLocationFsxOntapRequest.Builder> createLocationFsxOntapRequest)
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer.
|
default CreateLocationFsxOntapResponse |
createLocationFsxOntap(CreateLocationFsxOntapRequest createLocationFsxOntapRequest)
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer.
|
default CreateLocationFsxOpenZfsResponse |
createLocationFsxOpenZfs(Consumer<CreateLocationFsxOpenZfsRequest.Builder> createLocationFsxOpenZfsRequest)
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer.
|
default CreateLocationFsxOpenZfsResponse |
createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest)
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer.
|
default CreateLocationFsxWindowsResponse |
createLocationFsxWindows(Consumer<CreateLocationFsxWindowsRequest.Builder> createLocationFsxWindowsRequest)
Creates an endpoint for an Amazon FSx for Windows File Server file system.
|
default CreateLocationFsxWindowsResponse |
createLocationFsxWindows(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest)
Creates an endpoint for an Amazon FSx for Windows File Server file system.
|
default CreateLocationHdfsResponse |
createLocationHdfs(Consumer<CreateLocationHdfsRequest.Builder> createLocationHdfsRequest)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
|
default CreateLocationHdfsResponse |
createLocationHdfs(CreateLocationHdfsRequest createLocationHdfsRequest)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
|
default CreateLocationNfsResponse |
createLocationNfs(Consumer<CreateLocationNfsRequest.Builder> createLocationNfsRequest)
Defines a file system on a Network File System (NFS) server that can be read from or written to.
|
default CreateLocationNfsResponse |
createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)
Defines a file system on a Network File System (NFS) server that can be read from or written to.
|
default CreateLocationObjectStorageResponse |
createLocationObjectStorage(Consumer<CreateLocationObjectStorageRequest.Builder> createLocationObjectStorageRequest)
Creates an endpoint for an object storage system that DataSync can access for a transfer.
|
default CreateLocationObjectStorageResponse |
createLocationObjectStorage(CreateLocationObjectStorageRequest createLocationObjectStorageRequest)
Creates an endpoint for an object storage system that DataSync can access for a transfer.
|
default CreateLocationS3Response |
createLocationS3(Consumer<CreateLocationS3Request.Builder> createLocationS3Request)
A location is an endpoint for an Amazon S3 bucket.
|
default CreateLocationS3Response |
createLocationS3(CreateLocationS3Request createLocationS3Request)
A location is an endpoint for an Amazon S3 bucket.
|
default CreateLocationSmbResponse |
createLocationSmb(Consumer<CreateLocationSmbRequest.Builder> createLocationSmbRequest)
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer.
|
default CreateLocationSmbResponse |
createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest)
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer.
|
default CreateTaskResponse |
createTask(Consumer<CreateTaskRequest.Builder> createTaskRequest)
Configures a task, which defines where and how DataSync transfers your data.
|
default CreateTaskResponse |
createTask(CreateTaskRequest createTaskRequest)
Configures a task, which defines where and how DataSync transfers your data.
|
default DeleteAgentResponse |
deleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest)
Deletes an agent.
|
default DeleteAgentResponse |
deleteAgent(DeleteAgentRequest deleteAgentRequest)
Deletes an agent.
|
default DeleteLocationResponse |
deleteLocation(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest)
Deletes the configuration of a location used by DataSync.
|
default DeleteLocationResponse |
deleteLocation(DeleteLocationRequest deleteLocationRequest)
Deletes the configuration of a location used by DataSync.
|
default DeleteTaskResponse |
deleteTask(Consumer<DeleteTaskRequest.Builder> deleteTaskRequest)
Deletes an DataSync task.
|
default DeleteTaskResponse |
deleteTask(DeleteTaskRequest deleteTaskRequest)
Deletes an DataSync task.
|
default DescribeAgentResponse |
describeAgent(Consumer<DescribeAgentRequest.Builder> describeAgentRequest)
Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
|
default DescribeAgentResponse |
describeAgent(DescribeAgentRequest describeAgentRequest)
Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
|
default DescribeDiscoveryJobResponse |
describeDiscoveryJob(Consumer<DescribeDiscoveryJobRequest.Builder> describeDiscoveryJobRequest)
Returns information about a DataSync discovery job.
|
default DescribeDiscoveryJobResponse |
describeDiscoveryJob(DescribeDiscoveryJobRequest describeDiscoveryJobRequest)
Returns information about a DataSync discovery job.
|
default DescribeLocationEfsResponse |
describeLocationEfs(Consumer<DescribeLocationEfsRequest.Builder> describeLocationEfsRequest)
Returns metadata about your DataSync location for an Amazon EFS file system.
|
default DescribeLocationEfsResponse |
describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)
Returns metadata about your DataSync location for an Amazon EFS file system.
|
default DescribeLocationFsxLustreResponse |
describeLocationFsxLustre(Consumer<DescribeLocationFsxLustreRequest.Builder> describeLocationFsxLustreRequest)
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
|
default DescribeLocationFsxLustreResponse |
describeLocationFsxLustre(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest)
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
|
default DescribeLocationFsxOntapResponse |
describeLocationFsxOntap(Consumer<DescribeLocationFsxOntapRequest.Builder> describeLocationFsxOntapRequest)
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
|
default DescribeLocationFsxOntapResponse |
describeLocationFsxOntap(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest)
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
|
default DescribeLocationFsxOpenZfsResponse |
describeLocationFsxOpenZfs(Consumer<DescribeLocationFsxOpenZfsRequest.Builder> describeLocationFsxOpenZfsRequest)
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
|
default DescribeLocationFsxOpenZfsResponse |
describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest)
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
|
default DescribeLocationFsxWindowsResponse |
describeLocationFsxWindows(Consumer<DescribeLocationFsxWindowsRequest.Builder> describeLocationFsxWindowsRequest)
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
|
default DescribeLocationFsxWindowsResponse |
describeLocationFsxWindows(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest)
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
|
default DescribeLocationHdfsResponse |
describeLocationHdfs(Consumer<DescribeLocationHdfsRequest.Builder> describeLocationHdfsRequest)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS)
location.
|
default DescribeLocationHdfsResponse |
describeLocationHdfs(DescribeLocationHdfsRequest describeLocationHdfsRequest)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS)
location.
|
default DescribeLocationNfsResponse |
describeLocationNfs(Consumer<DescribeLocationNfsRequest.Builder> describeLocationNfsRequest)
Returns metadata, such as the path information, about an NFS location.
|
default DescribeLocationNfsResponse |
describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)
Returns metadata, such as the path information, about an NFS location.
|
default DescribeLocationObjectStorageResponse |
describeLocationObjectStorage(Consumer<DescribeLocationObjectStorageRequest.Builder> describeLocationObjectStorageRequest)
Returns metadata about your DataSync location for an object storage system.
|
default DescribeLocationObjectStorageResponse |
describeLocationObjectStorage(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest)
Returns metadata about your DataSync location for an object storage system.
|
default DescribeLocationS3Response |
describeLocationS3(Consumer<DescribeLocationS3Request.Builder> describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
|
default DescribeLocationS3Response |
describeLocationS3(DescribeLocationS3Request describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
|
default DescribeLocationSmbResponse |
describeLocationSmb(Consumer<DescribeLocationSmbRequest.Builder> describeLocationSmbRequest)
Returns metadata, such as the path and user information about an SMB location.
|
default DescribeLocationSmbResponse |
describeLocationSmb(DescribeLocationSmbRequest describeLocationSmbRequest)
Returns metadata, such as the path and user information about an SMB location.
|
default DescribeStorageSystemResponse |
describeStorageSystem(Consumer<DescribeStorageSystemRequest.Builder> describeStorageSystemRequest)
Returns information about an on-premises storage system that you're using with DataSync Discovery.
|
default DescribeStorageSystemResponse |
describeStorageSystem(DescribeStorageSystemRequest describeStorageSystemRequest)
Returns information about an on-premises storage system that you're using with DataSync Discovery.
|
default DescribeStorageSystemResourceMetricsResponse |
describeStorageSystemResourceMetrics(Consumer<DescribeStorageSystemResourceMetricsRequest.Builder> describeStorageSystemResourceMetricsRequest)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a
specific resource in your-premises storage system.
|
default DescribeStorageSystemResourceMetricsResponse |
describeStorageSystemResourceMetrics(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a
specific resource in your-premises storage system.
|
default DescribeStorageSystemResourceMetricsIterable |
describeStorageSystemResourceMetricsPaginator(Consumer<DescribeStorageSystemResourceMetricsRequest.Builder> describeStorageSystemResourceMetricsRequest)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a
specific resource in your-premises storage system.
|
default DescribeStorageSystemResourceMetricsIterable |
describeStorageSystemResourceMetricsPaginator(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a
specific resource in your-premises storage system.
|
default DescribeStorageSystemResourcesResponse |
describeStorageSystemResources(Consumer<DescribeStorageSystemResourcesRequest.Builder> describeStorageSystemResourcesRequest)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
|
default DescribeStorageSystemResourcesResponse |
describeStorageSystemResources(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
|
default DescribeStorageSystemResourcesIterable |
describeStorageSystemResourcesPaginator(Consumer<DescribeStorageSystemResourcesRequest.Builder> describeStorageSystemResourcesRequest)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
|
default DescribeStorageSystemResourcesIterable |
describeStorageSystemResourcesPaginator(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
|
default DescribeTaskResponse |
describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest)
Returns metadata about a task.
|
default DescribeTaskResponse |
describeTask(DescribeTaskRequest describeTaskRequest)
Returns metadata about a task.
|
default DescribeTaskExecutionResponse |
describeTaskExecution(Consumer<DescribeTaskExecutionRequest.Builder> describeTaskExecutionRequest)
Returns detailed metadata about a task that is being executed.
|
default DescribeTaskExecutionResponse |
describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)
Returns detailed metadata about a task that is being executed.
|
default GenerateRecommendationsResponse |
generateRecommendations(Consumer<GenerateRecommendationsRequest.Builder> generateRecommendationsRequest)
Creates recommendations about where to migrate your data to in Amazon Web Services.
|
default GenerateRecommendationsResponse |
generateRecommendations(GenerateRecommendationsRequest generateRecommendationsRequest)
Creates recommendations about where to migrate your data to in Amazon Web Services.
|
default ListAgentsResponse |
listAgents()
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region
specified in the request.
|
default ListAgentsResponse |
listAgents(Consumer<ListAgentsRequest.Builder> listAgentsRequest)
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region
specified in the request.
|
default ListAgentsResponse |
listAgents(ListAgentsRequest listAgentsRequest)
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region
specified in the request.
|
default ListAgentsIterable |
listAgentsPaginator()
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region
specified in the request.
|
default ListAgentsIterable |
listAgentsPaginator(Consumer<ListAgentsRequest.Builder> listAgentsRequest)
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region
specified in the request.
|
default ListAgentsIterable |
listAgentsPaginator(ListAgentsRequest listAgentsRequest)
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region
specified in the request.
|
default ListDiscoveryJobsResponse |
listDiscoveryJobs(Consumer<ListDiscoveryJobsRequest.Builder> listDiscoveryJobsRequest)
Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account
where you're using DataSync Discovery.
|
default ListDiscoveryJobsResponse |
listDiscoveryJobs(ListDiscoveryJobsRequest listDiscoveryJobsRequest)
Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account
where you're using DataSync Discovery.
|
default ListDiscoveryJobsIterable |
listDiscoveryJobsPaginator(Consumer<ListDiscoveryJobsRequest.Builder> listDiscoveryJobsRequest)
Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account
where you're using DataSync Discovery.
|
default ListDiscoveryJobsIterable |
listDiscoveryJobsPaginator(ListDiscoveryJobsRequest listDiscoveryJobsRequest)
Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account
where you're using DataSync Discovery.
|
default ListLocationsResponse |
listLocations()
Returns a list of source and destination locations.
|
default ListLocationsResponse |
listLocations(Consumer<ListLocationsRequest.Builder> listLocationsRequest)
Returns a list of source and destination locations.
|
default ListLocationsResponse |
listLocations(ListLocationsRequest listLocationsRequest)
Returns a list of source and destination locations.
|
default ListLocationsIterable |
listLocationsPaginator()
Returns a list of source and destination locations.
|
default ListLocationsIterable |
listLocationsPaginator(Consumer<ListLocationsRequest.Builder> listLocationsRequest)
Returns a list of source and destination locations.
|
default ListLocationsIterable |
listLocationsPaginator(ListLocationsRequest listLocationsRequest)
Returns a list of source and destination locations.
|
default ListStorageSystemsResponse |
listStorageSystems(Consumer<ListStorageSystemsRequest.Builder> listStorageSystemsRequest)
Lists the on-premises storage systems that you're using with DataSync Discovery.
|
default ListStorageSystemsResponse |
listStorageSystems(ListStorageSystemsRequest listStorageSystemsRequest)
Lists the on-premises storage systems that you're using with DataSync Discovery.
|
default ListStorageSystemsIterable |
listStorageSystemsPaginator(Consumer<ListStorageSystemsRequest.Builder> listStorageSystemsRequest)
Lists the on-premises storage systems that you're using with DataSync Discovery.
|
default ListStorageSystemsIterable |
listStorageSystemsPaginator(ListStorageSystemsRequest listStorageSystemsRequest)
Lists the on-premises storage systems that you're using with DataSync Discovery.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
|
default ListTaskExecutionsResponse |
listTaskExecutions()
Returns a list of executed tasks.
|
default ListTaskExecutionsResponse |
listTaskExecutions(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)
Returns a list of executed tasks.
|
default ListTaskExecutionsResponse |
listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
|
default ListTaskExecutionsIterable |
listTaskExecutionsPaginator()
Returns a list of executed tasks.
|
default ListTaskExecutionsIterable |
listTaskExecutionsPaginator(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)
Returns a list of executed tasks.
|
default ListTaskExecutionsIterable |
listTaskExecutionsPaginator(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
|
default ListTasksResponse |
listTasks()
Returns a list of the DataSync tasks you created.
|
default ListTasksResponse |
listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of the DataSync tasks you created.
|
default ListTasksResponse |
listTasks(ListTasksRequest listTasksRequest)
Returns a list of the DataSync tasks you created.
|
default ListTasksIterable |
listTasksPaginator()
Returns a list of the DataSync tasks you created.
|
default ListTasksIterable |
listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of the DataSync tasks you created.
|
default ListTasksIterable |
listTasksPaginator(ListTasksRequest listTasksRequest)
Returns a list of the DataSync tasks you created.
|
default RemoveStorageSystemResponse |
removeStorageSystem(Consumer<RemoveStorageSystemRequest.Builder> removeStorageSystemRequest)
Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs,
collected data, and recommendations.
|
default RemoveStorageSystemResponse |
removeStorageSystem(RemoveStorageSystemRequest removeStorageSystemRequest)
Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs,
collected data, and recommendations.
|
default DataSyncServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartDiscoveryJobResponse |
startDiscoveryJob(Consumer<StartDiscoveryJobRequest.Builder> startDiscoveryJobRequest)
Runs a DataSync discovery job on your on-premises storage system.
|
default StartDiscoveryJobResponse |
startDiscoveryJob(StartDiscoveryJobRequest startDiscoveryJobRequest)
Runs a DataSync discovery job on your on-premises storage system.
|
default StartTaskExecutionResponse |
startTaskExecution(Consumer<StartTaskExecutionRequest.Builder> startTaskExecutionRequest)
Starts an DataSync task.
|
default StartTaskExecutionResponse |
startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest)
Starts an DataSync task.
|
default StopDiscoveryJobResponse |
stopDiscoveryJob(Consumer<StopDiscoveryJobRequest.Builder> stopDiscoveryJobRequest)
Stops a running DataSync discovery job.
|
default StopDiscoveryJobResponse |
stopDiscoveryJob(StopDiscoveryJobRequest stopDiscoveryJobRequest)
Stops a running DataSync discovery job.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies a tag to an Amazon Web Services resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Applies a tag to an Amazon Web Services resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
default UpdateAgentResponse |
updateAgent(Consumer<UpdateAgentRequest.Builder> updateAgentRequest)
Updates the name of an agent.
|
default UpdateAgentResponse |
updateAgent(UpdateAgentRequest updateAgentRequest)
Updates the name of an agent.
|
default UpdateDiscoveryJobResponse |
updateDiscoveryJob(Consumer<UpdateDiscoveryJobRequest.Builder> updateDiscoveryJobRequest)
Edits a DataSync discovery job configuration.
|
default UpdateDiscoveryJobResponse |
updateDiscoveryJob(UpdateDiscoveryJobRequest updateDiscoveryJobRequest)
Edits a DataSync discovery job configuration.
|
default UpdateLocationHdfsResponse |
updateLocationHdfs(Consumer<UpdateLocationHdfsRequest.Builder> updateLocationHdfsRequest)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
|
default UpdateLocationHdfsResponse |
updateLocationHdfs(UpdateLocationHdfsRequest updateLocationHdfsRequest)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
|
default UpdateLocationNfsResponse |
updateLocationNfs(Consumer<UpdateLocationNfsRequest.Builder> updateLocationNfsRequest)
Updates some of the parameters of a previously created location for Network File System (NFS) access.
|
default UpdateLocationNfsResponse |
updateLocationNfs(UpdateLocationNfsRequest updateLocationNfsRequest)
Updates some of the parameters of a previously created location for Network File System (NFS) access.
|
default UpdateLocationObjectStorageResponse |
updateLocationObjectStorage(Consumer<UpdateLocationObjectStorageRequest.Builder> updateLocationObjectStorageRequest)
Updates some parameters of an existing object storage location that DataSync accesses for a transfer.
|
default UpdateLocationObjectStorageResponse |
updateLocationObjectStorage(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest)
Updates some parameters of an existing object storage location that DataSync accesses for a transfer.
|
default UpdateLocationSmbResponse |
updateLocationSmb(Consumer<UpdateLocationSmbRequest.Builder> updateLocationSmbRequest)
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system
access.
|
default UpdateLocationSmbResponse |
updateLocationSmb(UpdateLocationSmbRequest updateLocationSmbRequest)
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system
access.
|
default UpdateStorageSystemResponse |
updateStorageSystem(Consumer<UpdateStorageSystemRequest.Builder> updateStorageSystemRequest)
Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
|
default UpdateStorageSystemResponse |
updateStorageSystem(UpdateStorageSystemRequest updateStorageSystemRequest)
Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
|
default UpdateTaskResponse |
updateTask(Consumer<UpdateTaskRequest.Builder> updateTaskRequest)
Updates the metadata associated with a task.
|
default UpdateTaskResponse |
updateTask(UpdateTaskRequest updateTaskRequest)
Updates the metadata associated with a task.
|
default UpdateTaskExecutionResponse |
updateTaskExecution(Consumer<UpdateTaskExecutionRequest.Builder> updateTaskExecutionRequest)
Modifies a running DataSync task.
|
default UpdateTaskExecutionResponse |
updateTaskExecution(UpdateTaskExecutionRequest updateTaskExecutionRequest)
Modifies a running DataSync task.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
addStorageSystemRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via AddStorageSystemRequest.builder()
addStorageSystemRequest - A Consumer that will call methods on AddStorageSystemRequest.Builder to create a request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
cancelTaskExecutionRequest - CancelTaskExecutionRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via CancelTaskExecutionRequest.builder()
cancelTaskExecutionRequest - A Consumer that will call methods on CancelTaskExecutionRequest.Builder to create a
request. CancelTaskExecutionRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAgentResponse createAgent(CreateAgentRequest createAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Activates an DataSync agent that you have deployed in your storage environment. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.
You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet.
You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.
Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
createAgentRequest - CreateAgentRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAgentResponse createAgent(Consumer<CreateAgentRequest.Builder> createAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Activates an DataSync agent that you have deployed in your storage environment. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.
You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet.
You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.
Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
This is a convenience which creates an instance of the CreateAgentRequest.Builder avoiding the need to
create one manually via CreateAgentRequest.builder()
createAgentRequest - A Consumer that will call methods on CreateAgentRequest.Builder to create a request.
CreateAgentRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationEfsResponse createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see Creating a location for Amazon EFS.
createLocationEfsRequest - CreateLocationEfsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationEfsResponse createLocationEfs(Consumer<CreateLocationEfsRequest.Builder> createLocationEfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see Creating a location for Amazon EFS.
This is a convenience which creates an instance of the CreateLocationEfsRequest.Builder avoiding the need
to create one manually via CreateLocationEfsRequest.builder()
createLocationEfsRequest - A Consumer that will call methods on CreateLocationEfsRequest.Builder to create a request.
CreateLocationEfsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationFsxLustreResponse createLocationFsxLustre(CreateLocationFsxLustreRequest createLocationFsxLustreRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for an Amazon FSx for Lustre file system.
createLocationFsxLustreRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationFsxLustreResponse createLocationFsxLustre(Consumer<CreateLocationFsxLustreRequest.Builder> createLocationFsxLustreRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for an Amazon FSx for Lustre file system.
This is a convenience which creates an instance of the CreateLocationFsxLustreRequest.Builder avoiding
the need to create one manually via CreateLocationFsxLustreRequest.builder()
createLocationFsxLustreRequest - A Consumer that will call methods on CreateLocationFsxLustreRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationFsxOntapResponse createLocationFsxOntap(CreateLocationFsxOntapRequest createLocationFsxOntapRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for ONTAP.
createLocationFsxOntapRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationFsxOntapResponse createLocationFsxOntap(Consumer<CreateLocationFsxOntapRequest.Builder> createLocationFsxOntapRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for ONTAP.
This is a convenience which creates an instance of the CreateLocationFsxOntapRequest.Builder avoiding the
need to create one manually via CreateLocationFsxOntapRequest.builder()
createLocationFsxOntapRequest - A Consumer that will call methods on CreateLocationFsxOntapRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationFsxOpenZfsResponse createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for OpenZFS.
Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs
operation.
createLocationFsxOpenZfsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationFsxOpenZfsResponse createLocationFsxOpenZfs(Consumer<CreateLocationFsxOpenZfsRequest.Builder> createLocationFsxOpenZfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for OpenZFS.
Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs
operation.
This is a convenience which creates an instance of the CreateLocationFsxOpenZfsRequest.Builder avoiding
the need to create one manually via CreateLocationFsxOpenZfsRequest.builder()
createLocationFsxOpenZfsRequest - A Consumer that will call methods on CreateLocationFsxOpenZfsRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationFsxWindowsResponse createLocationFsxWindows(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for an Amazon FSx for Windows File Server file system.
createLocationFsxWindowsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationFsxWindowsResponse createLocationFsxWindows(Consumer<CreateLocationFsxWindowsRequest.Builder> createLocationFsxWindowsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for an Amazon FSx for Windows File Server file system.
This is a convenience which creates an instance of the CreateLocationFsxWindowsRequest.Builder avoiding
the need to create one manually via CreateLocationFsxWindowsRequest.builder()
createLocationFsxWindowsRequest - A Consumer that will call methods on CreateLocationFsxWindowsRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationHdfsResponse createLocationHdfs(CreateLocationHdfsRequest createLocationHdfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for a Hadoop Distributed File System (HDFS).
createLocationHdfsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationHdfsResponse createLocationHdfs(Consumer<CreateLocationHdfsRequest.Builder> createLocationHdfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for a Hadoop Distributed File System (HDFS).
This is a convenience which creates an instance of the CreateLocationHdfsRequest.Builder avoiding the
need to create one manually via CreateLocationHdfsRequest.builder()
createLocationHdfsRequest - A Consumer that will call methods on CreateLocationHdfsRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationNfsResponse createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Defines a file system on a Network File System (NFS) server that can be read from or written to.
createLocationNfsRequest - CreateLocationNfsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationNfsResponse createLocationNfs(Consumer<CreateLocationNfsRequest.Builder> createLocationNfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Defines a file system on a Network File System (NFS) server that can be read from or written to.
This is a convenience which creates an instance of the CreateLocationNfsRequest.Builder avoiding the need
to create one manually via CreateLocationNfsRequest.builder()
createLocationNfsRequest - A Consumer that will call methods on CreateLocationNfsRequest.Builder to create a request.
CreateLocationNfsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationObjectStorageResponse createLocationObjectStorage(CreateLocationObjectStorageRequest createLocationObjectStorageRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see Creating a location for object storage.
createLocationObjectStorageRequest - CreateLocationObjectStorageRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationObjectStorageResponse createLocationObjectStorage(Consumer<CreateLocationObjectStorageRequest.Builder> createLocationObjectStorageRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see Creating a location for object storage.
This is a convenience which creates an instance of the CreateLocationObjectStorageRequest.Builder
avoiding the need to create one manually via CreateLocationObjectStorageRequest.builder()
createLocationObjectStorageRequest - A Consumer that will call methods on CreateLocationObjectStorageRequest.Builder to create
a request. CreateLocationObjectStorageRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationS3Response createLocationS3(CreateLocationS3Request createLocationS3Request) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
A location is an endpoint for an Amazon S3 bucket. DataSync can use the location as a source or destination for copying data.
Before you create your location, make sure that you read the following sections:
For more information, see Creating an Amazon S3 location.
createLocationS3Request - CreateLocationS3RequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationS3Response createLocationS3(Consumer<CreateLocationS3Request.Builder> createLocationS3Request) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
A location is an endpoint for an Amazon S3 bucket. DataSync can use the location as a source or destination for copying data.
Before you create your location, make sure that you read the following sections:
For more information, see Creating an Amazon S3 location.
This is a convenience which creates an instance of the CreateLocationS3Request.Builder avoiding the need
to create one manually via CreateLocationS3Request.builder()
createLocationS3Request - A Consumer that will call methods on CreateLocationS3Request.Builder to create a request.
CreateLocationS3RequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationSmbResponse createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer. For more information, see Creating an SMB location.
createLocationSmbRequest - CreateLocationSmbRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLocationSmbResponse createLocationSmb(Consumer<CreateLocationSmbRequest.Builder> createLocationSmbRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer. For more information, see Creating an SMB location.
This is a convenience which creates an instance of the CreateLocationSmbRequest.Builder avoiding the need
to create one manually via CreateLocationSmbRequest.builder()
createLocationSmbRequest - A Consumer that will call methods on CreateLocationSmbRequest.Builder to create a request.
CreateLocationSmbRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
createTaskRequest - CreateTaskRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
This is a convenience which creates an instance of the CreateTaskRequest.Builder avoiding the need to
create one manually via CreateTaskRequest.builder()
createTaskRequest - A Consumer that will call methods on CreateTaskRequest.Builder to create a request.
CreateTaskRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAgentResponse deleteAgent(DeleteAgentRequest deleteAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
deleteAgentRequest - DeleteAgentRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAgentResponse deleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
This is a convenience which creates an instance of the DeleteAgentRequest.Builder avoiding the need to
create one manually via DeleteAgentRequest.builder()
deleteAgentRequest - A Consumer that will call methods on DeleteAgentRequest.Builder to create a request.
DeleteAgentRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLocationResponse deleteLocation(DeleteLocationRequest deleteLocationRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Deletes the configuration of a location used by DataSync.
deleteLocationRequest - DeleteLocationInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLocationResponse deleteLocation(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Deletes the configuration of a location used by DataSync.
This is a convenience which creates an instance of the DeleteLocationRequest.Builder avoiding the need to
create one manually via DeleteLocationRequest.builder()
deleteLocationRequest - A Consumer that will call methods on DeleteLocationRequest.Builder to create a request.
DeleteLocationInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteTaskResponse deleteTask(DeleteTaskRequest deleteTaskRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Deletes an DataSync task.
deleteTaskRequest - DeleteTaskInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteTaskResponse deleteTask(Consumer<DeleteTaskRequest.Builder> deleteTaskRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Deletes an DataSync task.
This is a convenience which creates an instance of the DeleteTaskRequest.Builder avoiding the need to
create one manually via DeleteTaskRequest.builder()
deleteTaskRequest - A Consumer that will call methods on DeleteTaskRequest.Builder to create a request.
DeleteTaskInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAgentResponse describeAgent(DescribeAgentRequest describeAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
describeAgentRequest - DescribeAgentInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAgentResponse describeAgent(Consumer<DescribeAgentRequest.Builder> describeAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
This is a convenience which creates an instance of the DescribeAgentRequest.Builder avoiding the need to
create one manually via DescribeAgentRequest.builder()
describeAgentRequest - A Consumer that will call methods on DescribeAgentRequest.Builder to create a request.
DescribeAgentInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDiscoveryJobResponse describeDiscoveryJob(DescribeDiscoveryJobRequest describeDiscoveryJobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns information about a DataSync discovery job.
describeDiscoveryJobRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via DescribeDiscoveryJobRequest.builder()
describeDiscoveryJobRequest - A Consumer that will call methods on DescribeDiscoveryJobRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationEfsResponse describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata about your DataSync location for an Amazon EFS file system.
describeLocationEfsRequest - DescribeLocationEfsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationEfsResponse describeLocationEfs(Consumer<DescribeLocationEfsRequest.Builder> describeLocationEfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata about your DataSync location for an Amazon EFS file system.
This is a convenience which creates an instance of the DescribeLocationEfsRequest.Builder avoiding the
need to create one manually via DescribeLocationEfsRequest.builder()
describeLocationEfsRequest - A Consumer that will call methods on DescribeLocationEfsRequest.Builder to create a
request. DescribeLocationEfsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationFsxLustreResponse describeLocationFsxLustre(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
describeLocationFsxLustreRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationFsxLustreResponse describeLocationFsxLustre(Consumer<DescribeLocationFsxLustreRequest.Builder> describeLocationFsxLustreRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
This is a convenience which creates an instance of the DescribeLocationFsxLustreRequest.Builder avoiding
the need to create one manually via DescribeLocationFsxLustreRequest.builder()
describeLocationFsxLustreRequest - A Consumer that will call methods on DescribeLocationFsxLustreRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationFsxOntapResponse describeLocationFsxOntap(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a
Password.
describeLocationFsxOntapRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationFsxOntapResponse describeLocationFsxOntap(Consumer<DescribeLocationFsxOntapRequest.Builder> describeLocationFsxOntapRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a
Password.
This is a convenience which creates an instance of the DescribeLocationFsxOntapRequest.Builder avoiding
the need to create one manually via DescribeLocationFsxOntapRequest.builder()
describeLocationFsxOntapRequest - A Consumer that will call methods on DescribeLocationFsxOntapRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationFsxOpenZfsResponse describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs
operation.
describeLocationFsxOpenZfsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationFsxOpenZfsResponse describeLocationFsxOpenZfs(Consumer<DescribeLocationFsxOpenZfsRequest.Builder> describeLocationFsxOpenZfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs
operation.
This is a convenience which creates an instance of the DescribeLocationFsxOpenZfsRequest.Builder avoiding
the need to create one manually via DescribeLocationFsxOpenZfsRequest.builder()
describeLocationFsxOpenZfsRequest - A Consumer that will call methods on DescribeLocationFsxOpenZfsRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationFsxWindowsResponse describeLocationFsxWindows(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
describeLocationFsxWindowsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationFsxWindowsResponse describeLocationFsxWindows(Consumer<DescribeLocationFsxWindowsRequest.Builder> describeLocationFsxWindowsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
This is a convenience which creates an instance of the DescribeLocationFsxWindowsRequest.Builder avoiding
the need to create one manually via DescribeLocationFsxWindowsRequest.builder()
describeLocationFsxWindowsRequest - A Consumer that will call methods on DescribeLocationFsxWindowsRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationHdfsResponse describeLocationHdfs(DescribeLocationHdfsRequest describeLocationHdfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
describeLocationHdfsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationHdfsResponse describeLocationHdfs(Consumer<DescribeLocationHdfsRequest.Builder> describeLocationHdfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
This is a convenience which creates an instance of the DescribeLocationHdfsRequest.Builder avoiding the
need to create one manually via DescribeLocationHdfsRequest.builder()
describeLocationHdfsRequest - A Consumer that will call methods on DescribeLocationHdfsRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationNfsResponse describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata, such as the path information, about an NFS location.
describeLocationNfsRequest - DescribeLocationNfsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationNfsResponse describeLocationNfs(Consumer<DescribeLocationNfsRequest.Builder> describeLocationNfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata, such as the path information, about an NFS location.
This is a convenience which creates an instance of the DescribeLocationNfsRequest.Builder avoiding the
need to create one manually via DescribeLocationNfsRequest.builder()
describeLocationNfsRequest - A Consumer that will call methods on DescribeLocationNfsRequest.Builder to create a
request. DescribeLocationNfsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationObjectStorageResponse describeLocationObjectStorage(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata about your DataSync location for an object storage system.
describeLocationObjectStorageRequest - DescribeLocationObjectStorageRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationObjectStorageResponse describeLocationObjectStorage(Consumer<DescribeLocationObjectStorageRequest.Builder> describeLocationObjectStorageRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata about your DataSync location for an object storage system.
This is a convenience which creates an instance of the DescribeLocationObjectStorageRequest.Builder
avoiding the need to create one manually via DescribeLocationObjectStorageRequest.builder()
describeLocationObjectStorageRequest - A Consumer that will call methods on DescribeLocationObjectStorageRequest.Builder to
create a request. DescribeLocationObjectStorageRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationS3Response describeLocationS3(DescribeLocationS3Request describeLocationS3Request) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3Request - DescribeLocationS3RequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationS3Response describeLocationS3(Consumer<DescribeLocationS3Request.Builder> describeLocationS3Request) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
This is a convenience which creates an instance of the DescribeLocationS3Request.Builder avoiding the
need to create one manually via DescribeLocationS3Request.builder()
describeLocationS3Request - A Consumer that will call methods on DescribeLocationS3Request.Builder to create a
request. DescribeLocationS3RequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationSmbResponse describeLocationSmb(DescribeLocationSmbRequest describeLocationSmbRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata, such as the path and user information about an SMB location.
describeLocationSmbRequest - DescribeLocationSmbRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeLocationSmbResponse describeLocationSmb(Consumer<DescribeLocationSmbRequest.Builder> describeLocationSmbRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata, such as the path and user information about an SMB location.
This is a convenience which creates an instance of the DescribeLocationSmbRequest.Builder avoiding the
need to create one manually via DescribeLocationSmbRequest.builder()
describeLocationSmbRequest - A Consumer that will call methods on DescribeLocationSmbRequest.Builder to create a
request. DescribeLocationSmbRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeStorageSystemRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via DescribeStorageSystemRequest.builder()
describeStorageSystemRequest - A Consumer that will call methods on DescribeStorageSystemRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeStorageSystemResourceMetricsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to create one manually via
DescribeStorageSystemResourceMetricsRequest.builder()
describeStorageSystemResourceMetricsRequest - A Consumer that will call methods on DescribeStorageSystemResourceMetricsRequest.Builder
to create a request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStorageSystemResourceMetricsIterable describeStorageSystemResourceMetricsPaginator(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.
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
software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourceMetricsIterable responses = client.describeStorageSystemResourceMetricsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeStorageSystemResourceMetricsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStorageSystemResourceMetricsIterable describeStorageSystemResourceMetricsPaginator(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 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
software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourceMetricsIterable responses = client.describeStorageSystemResourceMetricsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to create one manually via
DescribeStorageSystemResourceMetricsRequest.builder()
describeStorageSystemResourceMetricsRequest - A Consumer that will call methods on DescribeStorageSystemResourceMetricsRequest.Builder
to create a request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStorageSystemResourcesResponse describeStorageSystemResources(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
describeStorageSystemResourcesRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via DescribeStorageSystemResourcesRequest.builder()
describeStorageSystemResourcesRequest - A Consumer that will call methods on DescribeStorageSystemResourcesRequest.Builder to
create a request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStorageSystemResourcesIterable describeStorageSystemResourcesPaginator(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
This is a variant of
describeStorageSystemResources(software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesRequest)
operation. The return type is a custom 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
software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourcesIterable responses = client.describeStorageSystemResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeStorageSystemResourcesRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStorageSystemResourcesIterable describeStorageSystemResourcesPaginator(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 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
software.amazon.awssdk.services.datasync.paginators.DescribeStorageSystemResourcesIterable responses = client.describeStorageSystemResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder
avoiding the need to create one manually via DescribeStorageSystemResourcesRequest.builder()
describeStorageSystemResourcesRequest - A Consumer that will call methods on DescribeStorageSystemResourcesRequest.Builder to
create a request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTaskResponse describeTask(DescribeTaskRequest describeTaskRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata about a task.
describeTaskRequest - DescribeTaskRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTaskResponse describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns metadata about a task.
This is a convenience which creates an instance of the DescribeTaskRequest.Builder avoiding the need to
create one manually via DescribeTaskRequest.builder()
describeTaskRequest - A Consumer that will call methods on DescribeTaskRequest.Builder to create a request.
DescribeTaskRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTaskExecutionResponse describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns detailed metadata about a task that is being executed.
describeTaskExecutionRequest - DescribeTaskExecutionRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTaskExecutionResponse describeTaskExecution(Consumer<DescribeTaskExecutionRequest.Builder> describeTaskExecutionRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns detailed metadata about a task that is being executed.
This is a convenience which creates an instance of the DescribeTaskExecutionRequest.Builder avoiding the
need to create one manually via DescribeTaskExecutionRequest.builder()
describeTaskExecutionRequest - A Consumer that will call methods on DescribeTaskExecutionRequest.Builder to create a
request. DescribeTaskExecutionRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
If your discovery job completes successfully, you don't need to use this operation. DataSync Discovery generates the recommendations for you automatically.
generateRecommendationsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
If your discovery job completes successfully, you don't need to use this operation. DataSync Discovery generates the recommendations for you automatically.
This is a convenience which creates an instance of the GenerateRecommendationsRequest.Builder avoiding
the need to create one manually via GenerateRecommendationsRequest.builder()
generateRecommendationsRequest - A Consumer that will call methods on GenerateRecommendationsRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAgentsResponse listAgents() 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.
ListAgents is eventually consistent. This means the result of running the operation might not
reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then
immediately run ListAgents, that agent might not show up in the list right away. In situations like
this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.
InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistAgents(ListAgentsRequest),
AWS API
Documentationdefault 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.
ListAgents is eventually consistent. This means the result of running the operation might not
reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then
immediately run ListAgents, that agent might not show up in the list right away. In situations like
this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.
listAgentsRequest - ListAgentsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
ListAgents is eventually consistent. This means the result of running the operation might not
reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then
immediately run ListAgents, that agent might not show up in the list right away. In situations like
this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.
This is a convenience which creates an instance of the ListAgentsRequest.Builder avoiding the need to
create one manually via ListAgentsRequest.builder()
listAgentsRequest - A Consumer that will call methods on ListAgentsRequest.Builder to create a request.
ListAgentsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAgentsIterable listAgentsPaginator() 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.
ListAgents is eventually consistent. This means the result of running the operation might not
reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then
immediately run ListAgents, that agent might not show up in the list right away. In situations like
this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.
This is a variant of listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)
operation. The return type is a custom 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
software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistAgentsPaginator(ListAgentsRequest),
AWS API
Documentationdefault ListAgentsIterable listAgentsPaginator(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.
ListAgents is eventually consistent. This means the result of running the operation might not
reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then
immediately run ListAgents, that agent might not show up in the list right away. In situations like
this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.
This is a variant of listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)
operation. The return type is a custom 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
software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listAgentsRequest - ListAgentsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAgentsIterable listAgentsPaginator(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.
ListAgents is eventually consistent. This means the result of running the operation might not
reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then
immediately run ListAgents, that agent might not show up in the list right away. In situations like
this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.
This is a variant of listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)
operation. The return type is a custom 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
software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListAgentsRequest.builder()
listAgentsRequest - A Consumer that will call methods on ListAgentsRequest.Builder to create a request.
ListAgentsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listDiscoveryJobsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via ListDiscoveryJobsRequest.builder()
listDiscoveryJobsRequest - A Consumer that will call methods on ListDiscoveryJobsRequest.Builder to create a request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDiscoveryJobsIterable listDiscoveryJobsPaginator(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.
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
software.amazon.awssdk.services.datasync.paginators.ListDiscoveryJobsIterable responses = client.listDiscoveryJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listDiscoveryJobsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDiscoveryJobsIterable listDiscoveryJobsPaginator(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 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
software.amazon.awssdk.services.datasync.paginators.ListDiscoveryJobsIterable responses = client.listDiscoveryJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need
to create one manually via ListDiscoveryJobsRequest.builder()
listDiscoveryJobsRequest - A Consumer that will call methods on ListDiscoveryJobsRequest.Builder to create a request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLocationsResponse listLocations() 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.
InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistLocations(ListLocationsRequest),
AWS API
Documentationdefault 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.
listLocationsRequest - ListLocationsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ListLocationsRequest.builder()
listLocationsRequest - A Consumer that will call methods on ListLocationsRequest.Builder to create a request.
ListLocationsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLocationsIterable listLocationsPaginator() 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 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
software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistLocationsPaginator(ListLocationsRequest),
AWS API
Documentationdefault ListLocationsIterable listLocationsPaginator(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.
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
software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listLocationsRequest - ListLocationsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLocationsIterable listLocationsPaginator(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 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
software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListLocationsRequest.builder()
listLocationsRequest - A Consumer that will call methods on ListLocationsRequest.Builder to create a request.
ListLocationsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStorageSystemsResponse listStorageSystems(ListStorageSystemsRequest listStorageSystemsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Lists the on-premises storage systems that you're using with DataSync Discovery.
listStorageSystemsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListStorageSystemsRequest.builder()
listStorageSystemsRequest - A Consumer that will call methods on ListStorageSystemsRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStorageSystemsIterable listStorageSystemsPaginator(ListStorageSystemsRequest listStorageSystemsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Lists the on-premises storage systems that you're using with DataSync Discovery.
This is a variant of
listStorageSystems(software.amazon.awssdk.services.datasync.model.ListStorageSystemsRequest) operation.
The return type is a custom 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
software.amazon.awssdk.services.datasync.paginators.ListStorageSystemsIterable responses = client.listStorageSystemsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listStorageSystemsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStorageSystemsIterable listStorageSystemsPaginator(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 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
software.amazon.awssdk.services.datasync.paginators.ListStorageSystemsIterable responses = client.listStorageSystemsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the
need to create one manually via ListStorageSystemsRequest.builder()
listStorageSystemsRequest - A Consumer that will call methods on ListStorageSystemsRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns all the tags associated with an Amazon Web Services resource.
listTagsForResourceRequest - ListTagsForResourceRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request. ListTagsForResourceRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns all the tags associated with an Amazon Web Services resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest)
operation. The return type is a custom 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
software.amazon.awssdk.services.datasync.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listTagsForResourceRequest - ListTagsForResourceRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns all the tags associated with an Amazon Web Services resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest)
operation. The return type is a custom 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
software.amazon.awssdk.services.datasync.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request. ListTagsForResourceRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTaskExecutionsResponse listTaskExecutions() throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns a list of executed tasks.
InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistTaskExecutions(ListTaskExecutionsRequest),
AWS
API Documentationdefault ListTaskExecutionsResponse listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns a list of executed tasks.
listTaskExecutionsRequest - ListTaskExecutionsInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTaskExecutionsResponse listTaskExecutions(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns a list of executed tasks.
This is a convenience which creates an instance of the ListTaskExecutionsRequest.Builder avoiding the
need to create one manually via ListTaskExecutionsRequest.builder()
listTaskExecutionsRequest - A Consumer that will call methods on ListTaskExecutionsRequest.Builder to create a
request. ListTaskExecutionsInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTaskExecutionsIterable listTaskExecutionsPaginator() throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns a list of executed tasks.
This is a variant of
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest) operation.
The return type is a custom 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
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistTaskExecutionsPaginator(ListTaskExecutionsRequest),
AWS
API Documentationdefault ListTaskExecutionsIterable listTaskExecutionsPaginator(ListTaskExecutionsRequest listTaskExecutionsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns a list of executed tasks.
This is a variant of
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest) operation.
The return type is a custom 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
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listTaskExecutionsRequest - ListTaskExecutionsInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTaskExecutionsIterable listTaskExecutionsPaginator(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns a list of executed tasks.
This is a variant of
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest) operation.
The return type is a custom 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
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the
need to create one manually via ListTaskExecutionsRequest.builder()
listTaskExecutionsRequest - A Consumer that will call methods on ListTaskExecutionsRequest.Builder to create a
request. ListTaskExecutionsInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTasksResponse listTasks() throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns a list of the DataSync tasks you created.
InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistTasks(ListTasksRequest),
AWS API
Documentationdefault ListTasksResponse listTasks(ListTasksRequest listTasksRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns a list of the DataSync tasks you created.
listTasksRequest - ListTasksRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ListTasksRequest.builder()
listTasksRequest - A Consumer that will call methods on ListTasksRequest.Builder to create a request.
ListTasksRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTasksIterable listTasksPaginator() throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns a list of the DataSync tasks you created.
This is a variant of listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)
operation. The return type is a custom 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
software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistTasksPaginator(ListTasksRequest),
AWS API
Documentationdefault ListTasksIterable listTasksPaginator(ListTasksRequest listTasksRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns a list of the DataSync tasks you created.
This is a variant of listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)
operation. The return type is a custom 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
software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listTasksRequest - ListTasksRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTasksIterable listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Returns a list of the DataSync tasks you created.
This is a variant of listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)
operation. The return type is a custom 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
software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListTasksRequest.builder()
listTasksRequest - A Consumer that will call methods on ListTasksRequest.Builder to create a request.
ListTasksRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
removeStorageSystemRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via RemoveStorageSystemRequest.builder()
removeStorageSystemRequest - A Consumer that will call methods on RemoveStorageSystemRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
startDiscoveryJobRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via StartDiscoveryJobRequest.builder()
startDiscoveryJobRequest - A Consumer that will call methods on StartDiscoveryJobRequest.Builder to create a request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartTaskExecutionResponse startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Starts an DataSync task. For each task, you can only run one task execution at a time.
There are several phases to a task execution. For more information, see Task execution statuses.
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
startTaskExecutionRequest - StartTaskExecutionRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartTaskExecutionResponse startTaskExecution(Consumer<StartTaskExecutionRequest.Builder> startTaskExecutionRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Starts an DataSync task. For each task, you can only run one task execution at a time.
There are several phases to a task execution. For more information, see Task execution statuses.
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
This is a convenience which creates an instance of the StartTaskExecutionRequest.Builder avoiding the
need to create one manually via StartTaskExecutionRequest.builder()
startTaskExecutionRequest - A Consumer that will call methods on StartTaskExecutionRequest.Builder to create a
request. StartTaskExecutionRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
stopDiscoveryJobRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via StopDiscoveryJobRequest.builder()
stopDiscoveryJobRequest - A Consumer that will call methods on StopDiscoveryJobRequest.Builder to create a request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
tagResourceRequest - TagResourceRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
TagResourceRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Removes tags from an Amazon Web Services resource.
untagResourceRequest - UntagResourceRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
UntagResourceRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAgentResponse updateAgent(UpdateAgentRequest updateAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Updates the name of an agent.
updateAgentRequest - UpdateAgentRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAgentResponse updateAgent(Consumer<UpdateAgentRequest.Builder> updateAgentRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Updates the name of an agent.
This is a convenience which creates an instance of the UpdateAgentRequest.Builder avoiding the need to
create one manually via UpdateAgentRequest.builder()
updateAgentRequest - A Consumer that will call methods on UpdateAgentRequest.Builder to create a request.
UpdateAgentRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDiscoveryJobResponse updateDiscoveryJob(UpdateDiscoveryJobRequest updateDiscoveryJobRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Edits a DataSync discovery job configuration.
updateDiscoveryJobRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via UpdateDiscoveryJobRequest.builder()
updateDiscoveryJobRequest - A Consumer that will call methods on UpdateDiscoveryJobRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateLocationHdfsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via UpdateLocationHdfsRequest.builder()
updateLocationHdfsRequest - A Consumer that will call methods on UpdateLocationHdfsRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateLocationNfsResponse updateLocationNfs(UpdateLocationNfsRequest updateLocationNfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see Creating a location for NFS.
updateLocationNfsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateLocationNfsResponse updateLocationNfs(Consumer<UpdateLocationNfsRequest.Builder> updateLocationNfsRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see Creating a location for NFS.
This is a convenience which creates an instance of the UpdateLocationNfsRequest.Builder avoiding the need
to create one manually via UpdateLocationNfsRequest.builder()
updateLocationNfsRequest - A Consumer that will call methods on UpdateLocationNfsRequest.Builder to create a request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateLocationObjectStorageResponse updateLocationObjectStorage(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Updates some parameters of an existing object storage location that DataSync accesses for a transfer. For information about creating a self-managed object storage location, see Creating a location for object storage.
updateLocationObjectStorageRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateLocationObjectStorageResponse updateLocationObjectStorage(Consumer<UpdateLocationObjectStorageRequest.Builder> updateLocationObjectStorageRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Updates some parameters of an existing object storage location that DataSync accesses for a transfer. For information about creating a self-managed object storage location, see Creating a location for object storage.
This is a convenience which creates an instance of the UpdateLocationObjectStorageRequest.Builder
avoiding the need to create one manually via UpdateLocationObjectStorageRequest.builder()
updateLocationObjectStorageRequest - A Consumer that will call methods on UpdateLocationObjectStorageRequest.Builder to create
a request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateLocationSmbResponse updateLocationSmb(UpdateLocationSmbRequest updateLocationSmbRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB.
updateLocationSmbRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateLocationSmbResponse updateLocationSmb(Consumer<UpdateLocationSmbRequest.Builder> updateLocationSmbRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB.
This is a convenience which creates an instance of the UpdateLocationSmbRequest.Builder avoiding the need
to create one manually via UpdateLocationSmbRequest.builder()
updateLocationSmbRequest - A Consumer that will call methods on UpdateLocationSmbRequest.Builder to create a request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateStorageSystemRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via UpdateStorageSystemRequest.builder()
updateStorageSystemRequest - A Consumer that will call methods on UpdateStorageSystemRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateTaskResponse updateTask(UpdateTaskRequest updateTaskRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Updates the metadata associated with a task.
updateTaskRequest - UpdateTaskResponseInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateTaskResponse updateTask(Consumer<UpdateTaskRequest.Builder> updateTaskRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Updates the metadata associated with a task.
This is a convenience which creates an instance of the UpdateTaskRequest.Builder avoiding the need to
create one manually via UpdateTaskRequest.builder()
updateTaskRequest - A Consumer that will call methods on UpdateTaskRequest.Builder to create a request.
UpdateTaskResponseInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateTaskExecutionResponse updateTaskExecution(UpdateTaskExecutionRequest updateTaskExecutionRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Modifies a running DataSync task.
Currently, the only Option that you can modify with UpdateTaskExecution is
BytesPerSecond
, which throttles bandwidth for a running or queued task.
updateTaskExecutionRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateTaskExecutionResponse updateTaskExecution(Consumer<UpdateTaskExecutionRequest.Builder> updateTaskExecutionRequest) throws InvalidRequestException, InternalException, AwsServiceException, SdkClientException, DataSyncException
Modifies a running DataSync task.
Currently, the only Option that you can modify with UpdateTaskExecution is
BytesPerSecond
, which throttles bandwidth for a running or queued task.
This is a convenience which creates an instance of the UpdateTaskExecutionRequest.Builder avoiding the
need to create one manually via UpdateTaskExecutionRequest.builder()
updateTaskExecutionRequest - A Consumer that will call methods on UpdateTaskExecutionRequest.Builder to create a
request.InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic DataSyncClient create()
DataSyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static DataSyncClientBuilder builder()
DataSyncClient.static ServiceMetadata serviceMetadata()
default DataSyncServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.