Class: Aws::DataSync::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DataSync::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb
Overview
An API client for DataSync. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::DataSync::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_storage_system(params = {}) ⇒ Types::AddStorageSystemResponse
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
-
#cancel_task_execution(params = {}) ⇒ Struct
Stops an DataSync task execution that's in progress.
-
#create_agent(params = {}) ⇒ Types::CreateAgentResponse
Activates an DataSync agent that you have deployed in your storage environment.
-
#create_location_efs(params = {}) ⇒ Types::CreateLocationEfsResponse
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer.
-
#create_location_fsx_lustre(params = {}) ⇒ Types::CreateLocationFsxLustreResponse
Creates an endpoint for an Amazon FSx for Lustre file system.
-
#create_location_fsx_ontap(params = {}) ⇒ Types::CreateLocationFsxOntapResponse
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer.
-
#create_location_fsx_open_zfs(params = {}) ⇒ Types::CreateLocationFsxOpenZfsResponse
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer.
-
#create_location_fsx_windows(params = {}) ⇒ Types::CreateLocationFsxWindowsResponse
Creates an endpoint for an Amazon FSx for Windows File Server file system.
-
#create_location_hdfs(params = {}) ⇒ Types::CreateLocationHdfsResponse
Creates an endpoint for a Hadoop Distributed File System (HDFS).
-
#create_location_nfs(params = {}) ⇒ Types::CreateLocationNfsResponse
Defines a file system on a Network File System (NFS) server that can be read from or written to.
-
#create_location_object_storage(params = {}) ⇒ Types::CreateLocationObjectStorageResponse
Creates an endpoint for an object storage system that DataSync can access for a transfer.
-
#create_location_s3(params = {}) ⇒ Types::CreateLocationS3Response
A location is an endpoint for an Amazon S3 bucket.
-
#create_location_smb(params = {}) ⇒ Types::CreateLocationSmbResponse
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer.
-
#create_task(params = {}) ⇒ Types::CreateTaskResponse
Configures a task, which defines where and how DataSync transfers your data.
-
#delete_agent(params = {}) ⇒ Struct
Deletes an agent.
-
#delete_location(params = {}) ⇒ Struct
Deletes the configuration of a location used by DataSync.
-
#delete_task(params = {}) ⇒ Struct
Deletes an DataSync task.
-
#describe_agent(params = {}) ⇒ Types::DescribeAgentResponse
Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
-
#describe_discovery_job(params = {}) ⇒ Types::DescribeDiscoveryJobResponse
Returns information about a DataSync discovery job.
-
#describe_location_efs(params = {}) ⇒ Types::DescribeLocationEfsResponse
Returns metadata about your DataSync location for an Amazon EFS file system.
-
#describe_location_fsx_lustre(params = {}) ⇒ Types::DescribeLocationFsxLustreResponse
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
-
#describe_location_fsx_ontap(params = {}) ⇒ Types::DescribeLocationFsxOntapResponse
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
-
#describe_location_fsx_open_zfs(params = {}) ⇒ Types::DescribeLocationFsxOpenZfsResponse
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
-
#describe_location_fsx_windows(params = {}) ⇒ Types::DescribeLocationFsxWindowsResponse
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
-
#describe_location_hdfs(params = {}) ⇒ Types::DescribeLocationHdfsResponse
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
-
#describe_location_nfs(params = {}) ⇒ Types::DescribeLocationNfsResponse
Returns metadata, such as the path information, about an NFS location.
-
#describe_location_object_storage(params = {}) ⇒ Types::DescribeLocationObjectStorageResponse
Returns metadata about your DataSync location for an object storage system.
-
#describe_location_s3(params = {}) ⇒ Types::DescribeLocationS3Response
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
-
#describe_location_smb(params = {}) ⇒ Types::DescribeLocationSmbResponse
Returns metadata, such as the path and user information about an SMB location.
-
#describe_storage_system(params = {}) ⇒ Types::DescribeStorageSystemResponse
Returns information about an on-premises storage system that you're using with DataSync Discovery.
-
#describe_storage_system_resource_metrics(params = {}) ⇒ Types::DescribeStorageSystemResourceMetricsResponse
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
-
#describe_storage_system_resources(params = {}) ⇒ Types::DescribeStorageSystemResourcesResponse
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
-
#describe_task(params = {}) ⇒ Types::DescribeTaskResponse
Returns metadata about a task.
-
#describe_task_execution(params = {}) ⇒ Types::DescribeTaskExecutionResponse
Returns detailed metadata about a task that is being executed.
-
#generate_recommendations(params = {}) ⇒ Struct
Creates recommendations about where to migrate your data to in Amazon Web Services.
-
#list_agents(params = {}) ⇒ Types::ListAgentsResponse
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.
-
#list_discovery_jobs(params = {}) ⇒ Types::ListDiscoveryJobsResponse
Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you're using DataSync Discovery.
-
#list_locations(params = {}) ⇒ Types::ListLocationsResponse
Returns a list of source and destination locations.
-
#list_storage_systems(params = {}) ⇒ Types::ListStorageSystemsResponse
Lists the on-premises storage systems that you're using with DataSync Discovery.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns all the tags associated with an Amazon Web Services resource.
-
#list_task_executions(params = {}) ⇒ Types::ListTaskExecutionsResponse
Returns a list of executed tasks.
-
#list_tasks(params = {}) ⇒ Types::ListTasksResponse
Returns a list of the DataSync tasks you created.
-
#remove_storage_system(params = {}) ⇒ Struct
Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.
-
#start_discovery_job(params = {}) ⇒ Types::StartDiscoveryJobResponse
Runs a DataSync discovery job on your on-premises storage system.
-
#start_task_execution(params = {}) ⇒ Types::StartTaskExecutionResponse
Starts an DataSync task.
-
#stop_discovery_job(params = {}) ⇒ Struct
Stops a running DataSync discovery job.
-
#tag_resource(params = {}) ⇒ Struct
Applies a tag to an Amazon Web Services resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from an Amazon Web Services resource.
-
#update_agent(params = {}) ⇒ Struct
Updates the name of an agent.
-
#update_discovery_job(params = {}) ⇒ Struct
Edits a DataSync discovery job configuration.
-
#update_location_hdfs(params = {}) ⇒ Struct
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
-
#update_location_nfs(params = {}) ⇒ Struct
Updates some of the parameters of a previously created location for Network File System (NFS) access.
-
#update_location_object_storage(params = {}) ⇒ Struct
Updates some parameters of an existing object storage location that DataSync accesses for a transfer.
-
#update_location_smb(params = {}) ⇒ Struct
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access.
-
#update_storage_system(params = {}) ⇒ Struct
Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
-
#update_task(params = {}) ⇒ Struct
Updates the metadata associated with a task.
-
#update_task_execution(params = {}) ⇒ Struct
Modifies a running DataSync task.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
380 381 382 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 380 def initialize(*args) super end |
Instance Method Details
#add_storage_system(params = {}) ⇒ Types::AddStorageSystemResponse
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
467 468 469 470 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 467 def add_storage_system(params = {}, = {}) req = build_request(:add_storage_system, params) req.send_request() end |
#cancel_task_execution(params = {}) ⇒ Struct
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.
499 500 501 502 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 499 def cancel_task_execution(params = {}, = {}) req = build_request(:cancel_task_execution, params) req.send_request() end |
#create_agent(params = {}) ⇒ Types::CreateAgentResponse
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.
614 615 616 617 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 614 def create_agent(params = {}, = {}) req = build_request(:create_agent, params) req.send_request() end |
#create_location_efs(params = {}) ⇒ Types::CreateLocationEfsResponse
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.
700 701 702 703 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 700 def create_location_efs(params = {}, = {}) req = build_request(:create_location_efs, params) req.send_request() end |
#create_location_fsx_lustre(params = {}) ⇒ Types::CreateLocationFsxLustreResponse
Creates an endpoint for an Amazon FSx for Lustre file system.
751 752 753 754 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 751 def create_location_fsx_lustre(params = {}, = {}) req = build_request(:create_location_fsx_lustre, params) req.send_request() end |
#create_location_fsx_ontap(params = {}) ⇒ Types::CreateLocationFsxOntapResponse
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.
851 852 853 854 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 851 def create_location_fsx_ontap(params = {}, = {}) req = build_request(:create_location_fsx_ontap, params) req.send_request() end |
#create_location_fsx_open_zfs(params = {}) ⇒ Types::CreateLocationFsxOpenZfsResponse
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.
SMB
aren't supported with the
CreateLocationFsxOpenZfs
operation.
931 932 933 934 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 931 def create_location_fsx_open_zfs(params = {}, = {}) req = build_request(:create_location_fsx_open_zfs, params) req.send_request() end |
#create_location_fsx_windows(params = {}) ⇒ Types::CreateLocationFsxWindowsResponse
Creates an endpoint for an Amazon FSx for Windows File Server file system.
1013 1014 1015 1016 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1013 def create_location_fsx_windows(params = {}, = {}) req = build_request(:create_location_fsx_windows, params) req.send_request() end |
#create_location_hdfs(params = {}) ⇒ Types::CreateLocationHdfsResponse
Creates an endpoint for a Hadoop Distributed File System (HDFS).
1148 1149 1150 1151 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1148 def create_location_hdfs(params = {}, = {}) req = build_request(:create_location_hdfs, params) req.send_request() end |
#create_location_nfs(params = {}) ⇒ Types::CreateLocationNfsResponse
Defines a file system on a Network File System (NFS) server that can be read from or written to.
1255 1256 1257 1258 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1255 def create_location_nfs(params = {}, = {}) req = build_request(:create_location_nfs, params) req.send_request() end |
#create_location_object_storage(params = {}) ⇒ Types::CreateLocationObjectStorageResponse
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.
1349 1350 1351 1352 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1349 def create_location_object_storage(params = {}, = {}) req = build_request(:create_location_object_storage, params) req.send_request() end |
#create_location_s3(params = {}) ⇒ Types::CreateLocationS3Response
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.
1451 1452 1453 1454 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1451 def create_location_s3(params = {}, = {}) req = build_request(:create_location_s3, params) req.send_request() end |
#create_location_smb(params = {}) ⇒ Types::CreateLocationSmbResponse
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.
1564 1565 1566 1567 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1564 def create_location_smb(params = {}, = {}) req = build_request(:create_location_smb, params) req.send_request() end |
#create_task(params = {}) ⇒ Types::CreateTaskResponse
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.
1705 1706 1707 1708 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1705 def create_task(params = {}, = {}) req = build_request(:create_task, params) req.send_request() end |
#delete_agent(params = {}) ⇒ Struct
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.
1733 1734 1735 1736 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1733 def delete_agent(params = {}, = {}) req = build_request(:delete_agent, params) req.send_request() end |
#delete_location(params = {}) ⇒ Struct
Deletes the configuration of a location used by DataSync.
1755 1756 1757 1758 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1755 def delete_location(params = {}, = {}) req = build_request(:delete_location, params) req.send_request() end |
#delete_task(params = {}) ⇒ Struct
Deletes an DataSync task.
1778 1779 1780 1781 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1778 def delete_task(params = {}, = {}) req = build_request(:delete_task, params) req.send_request() end |
#describe_agent(params = {}) ⇒ Types::DescribeAgentResponse
Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
1825 1826 1827 1828 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1825 def describe_agent(params = {}, = {}) req = build_request(:describe_agent, params) req.send_request() end |
#describe_discovery_job(params = {}) ⇒ Types::DescribeDiscoveryJobResponse
Returns information about a DataSync discovery job.
1864 1865 1866 1867 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1864 def describe_discovery_job(params = {}, = {}) req = build_request(:describe_discovery_job, params) req.send_request() end |
#describe_location_efs(params = {}) ⇒ Types::DescribeLocationEfsResponse
Returns metadata about your DataSync location for an Amazon EFS file system.
1908 1909 1910 1911 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1908 def describe_location_efs(params = {}, = {}) req = build_request(:describe_location_efs, params) req.send_request() end |
#describe_location_fsx_lustre(params = {}) ⇒ Types::DescribeLocationFsxLustreResponse
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
1945 1946 1947 1948 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1945 def describe_location_fsx_lustre(params = {}, = {}) req = build_request(:describe_location_fsx_lustre, params) req.send_request() end |
#describe_location_fsx_ontap(params = {}) ⇒ Types::DescribeLocationFsxOntapResponse
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
DescribeLocationFsxOntap
operation
doesn't actually return a Password
.
1997 1998 1999 2000 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1997 def describe_location_fsx_ontap(params = {}, = {}) req = build_request(:describe_location_fsx_ontap, params) req.send_request() end |
#describe_location_fsx_open_zfs(params = {}) ⇒ Types::DescribeLocationFsxOpenZfsResponse
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
SMB
aren't supported with the
DescribeLocationFsxOpenZfs
operation.
2045 2046 2047 2048 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2045 def describe_location_fsx_open_zfs(params = {}, = {}) req = build_request(:describe_location_fsx_open_zfs, params) req.send_request() end |
#describe_location_fsx_windows(params = {}) ⇒ Types::DescribeLocationFsxWindowsResponse
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
2086 2087 2088 2089 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2086 def describe_location_fsx_windows(params = {}, = {}) req = build_request(:describe_location_fsx_windows, params) req.send_request() end |
#describe_location_hdfs(params = {}) ⇒ Types::DescribeLocationHdfsResponse
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
2142 2143 2144 2145 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2142 def describe_location_hdfs(params = {}, = {}) req = build_request(:describe_location_hdfs, params) req.send_request() end |
#describe_location_nfs(params = {}) ⇒ Types::DescribeLocationNfsResponse
Returns metadata, such as the path information, about an NFS location.
2179 2180 2181 2182 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2179 def describe_location_nfs(params = {}, = {}) req = build_request(:describe_location_nfs, params) req.send_request() end |
#describe_location_object_storage(params = {}) ⇒ Types::DescribeLocationObjectStorageResponse
Returns metadata about your DataSync location for an object storage system.
2224 2225 2226 2227 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2224 def describe_location_object_storage(params = {}, = {}) req = build_request(:describe_location_object_storage, params) req.send_request() end |
#describe_location_s3(params = {}) ⇒ Types::DescribeLocationS3Response
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
2265 2266 2267 2268 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2265 def describe_location_s3(params = {}, = {}) req = build_request(:describe_location_s3, params) req.send_request() end |
#describe_location_smb(params = {}) ⇒ Types::DescribeLocationSmbResponse
Returns metadata, such as the path and user information about an SMB location.
2307 2308 2309 2310 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2307 def describe_location_smb(params = {}, = {}) req = build_request(:describe_location_smb, params) req.send_request() end |
#describe_storage_system(params = {}) ⇒ Types::DescribeStorageSystemResponse
Returns information about an on-premises storage system that you're using with DataSync Discovery.
2357 2358 2359 2360 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2357 def describe_storage_system(params = {}, = {}) req = build_request(:describe_storage_system, params) req.send_request() end |
#describe_storage_system_resource_metrics(params = {}) ⇒ Types::DescribeStorageSystemResourceMetricsResponse
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2440 2441 2442 2443 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2440 def describe_storage_system_resource_metrics(params = {}, = {}) req = build_request(:describe_storage_system_resource_metrics, params) req.send_request() end |
#describe_storage_system_resources(params = {}) ⇒ Types::DescribeStorageSystemResourcesResponse
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2585 2586 2587 2588 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2585 def describe_storage_system_resources(params = {}, = {}) req = build_request(:describe_storage_system_resources, params) req.send_request() end |
#describe_task(params = {}) ⇒ Types::DescribeTaskResponse
Returns metadata about a task.
2663 2664 2665 2666 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2663 def describe_task(params = {}, = {}) req = build_request(:describe_task, params) req.send_request() end |
#describe_task_execution(params = {}) ⇒ Types::DescribeTaskExecutionResponse
Returns detailed metadata about a task that is being executed.
2741 2742 2743 2744 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2741 def describe_task_execution(params = {}, = {}) req = build_request(:describe_task_execution, params) req.send_request() end |
#generate_recommendations(params = {}) ⇒ Struct
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.
2793 2794 2795 2796 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2793 def generate_recommendations(params = {}, = {}) req = build_request(:generate_recommendations, params) req.send_request() end |
#list_agents(params = {}) ⇒ Types::ListAgentsResponse
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2854 2855 2856 2857 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2854 def list_agents(params = {}, = {}) req = build_request(:list_agents, params) req.send_request() end |
#list_discovery_jobs(params = {}) ⇒ Types::ListDiscoveryJobsResponse
Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you're using DataSync Discovery.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2901 2902 2903 2904 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2901 def list_discovery_jobs(params = {}, = {}) req = build_request(:list_discovery_jobs, params) req.send_request() end |
#list_locations(params = {}) ⇒ Types::ListLocationsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2958 2959 2960 2961 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2958 def list_locations(params = {}, = {}) req = build_request(:list_locations, params) req.send_request() end |
#list_storage_systems(params = {}) ⇒ Types::ListStorageSystemsResponse
Lists the on-premises storage systems that you're using with DataSync Discovery.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2998 2999 3000 3001 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2998 def list_storage_systems(params = {}, = {}) req = build_request(:list_storage_systems, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns all the tags associated with an Amazon Web Services resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3042 3043 3044 3045 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3042 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_task_executions(params = {}) ⇒ Types::ListTaskExecutionsResponse
Returns a list of executed tasks.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3086 3087 3088 3089 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3086 def list_task_executions(params = {}, = {}) req = build_request(:list_task_executions, params) req.send_request() end |
#list_tasks(params = {}) ⇒ Types::ListTasksResponse
Returns a list of the DataSync tasks you created.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3139 3140 3141 3142 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3139 def list_tasks(params = {}, = {}) req = build_request(:list_tasks, params) req.send_request() end |
#remove_storage_system(params = {}) ⇒ Struct
Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.
3164 3165 3166 3167 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3164 def remove_storage_system(params = {}, = {}) req = build_request(:remove_storage_system, params) req.send_request() end |
#start_discovery_job(params = {}) ⇒ Types::StartDiscoveryJobResponse
Runs a DataSync discovery job on your on-premises storage system. If you haven't added the storage system to DataSync Discovery yet, do this first by using the AddStorageSystem operation.
3229 3230 3231 3232 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3229 def start_discovery_job(params = {}, = {}) req = build_request(:start_discovery_job, params) req.send_request() end |
#start_task_execution(params = {}) ⇒ Types::StartTaskExecutionResponse
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.
3336 3337 3338 3339 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3336 def start_task_execution(params = {}, = {}) req = build_request(:start_task_execution, params) req.send_request() end |
#stop_discovery_job(params = {}) ⇒ Struct
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.
3369 3370 3371 3372 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3369 def stop_discovery_job(params = {}, = {}) req = build_request(:stop_discovery_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
3405 3406 3407 3408 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3405 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from an Amazon Web Services resource.
3432 3433 3434 3435 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3432 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_agent(params = {}) ⇒ Struct
Updates the name of an agent.
3458 3459 3460 3461 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3458 def update_agent(params = {}, = {}) req = build_request(:update_agent, params) req.send_request() end |
#update_discovery_job(params = {}) ⇒ Struct
Edits a DataSync discovery job configuration.
3487 3488 3489 3490 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3487 def update_discovery_job(params = {}, = {}) req = build_request(:update_discovery_job, params) req.send_request() end |
#update_location_hdfs(params = {}) ⇒ Struct
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
3582 3583 3584 3585 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3582 def update_location_hdfs(params = {}, = {}) req = build_request(:update_location_hdfs, params) req.send_request() end |
#update_location_nfs(params = {}) ⇒ Struct
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.
3656 3657 3658 3659 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3656 def update_location_nfs(params = {}, = {}) req = build_request(:update_location_nfs, params) req.send_request() end |
#update_location_object_storage(params = {}) ⇒ Struct
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.
3731 3732 3733 3734 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3731 def update_location_object_storage(params = {}, = {}) req = build_request(:update_location_object_storage, params) req.send_request() end |
#update_location_smb(params = {}) ⇒ Struct
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.
3813 3814 3815 3816 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3813 def update_location_smb(params = {}, = {}) req = build_request(:update_location_smb, params) req.send_request() end |
#update_storage_system(params = {}) ⇒ Struct
Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
3867 3868 3869 3870 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3867 def update_storage_system(params = {}, = {}) req = build_request(:update_storage_system, params) req.send_request() end |
#update_task(params = {}) ⇒ Struct
Updates the metadata associated with a task.
3970 3971 3972 3973 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3970 def update_task(params = {}, = {}) req = build_request(:update_task, params) req.send_request() end |
#update_task_execution(params = {}) ⇒ Struct
Modifies a running DataSync task.
Option
that you can modify with
UpdateTaskExecution
is BytesPerSecond
, which throttles bandwidth
for a running or queued task.
4025 4026 4027 4028 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4025 def update_task_execution(params = {}, = {}) req = build_request(:update_task_execution, params) req.send_request() end |