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 deploy in your storage environment.
-
#create_location_azure_blob(params = {}) ⇒ Types::CreateLocationAzureBlobResponse
Creates a transfer location for a Microsoft Azure Blob Storage container.
-
#create_location_efs(params = {}) ⇒ Types::CreateLocationEfsResponse
Creates a transfer location for an Amazon EFS file system.
-
#create_location_fsx_lustre(params = {}) ⇒ Types::CreateLocationFsxLustreResponse
Creates a transfer location for an Amazon FSx for Lustre file system.
-
#create_location_fsx_ontap(params = {}) ⇒ Types::CreateLocationFsxOntapResponse
Creates a transfer location for an Amazon FSx for NetApp ONTAP file system.
-
#create_location_fsx_open_zfs(params = {}) ⇒ Types::CreateLocationFsxOpenZfsResponse
Creates a transfer location for an Amazon FSx for OpenZFS file system.
-
#create_location_fsx_windows(params = {}) ⇒ Types::CreateLocationFsxWindowsResponse
Creates a transfer location for an Amazon FSx for Windows File Server file system.
-
#create_location_hdfs(params = {}) ⇒ Types::CreateLocationHdfsResponse
Creates a transfer location for a Hadoop Distributed File System (HDFS).
-
#create_location_nfs(params = {}) ⇒ Types::CreateLocationNfsResponse
Creates a transfer location for a Network File System (NFS) file server.
-
#create_location_object_storage(params = {}) ⇒ Types::CreateLocationObjectStorageResponse
Creates a transfer location for an object storage system.
-
#create_location_s3(params = {}) ⇒ Types::CreateLocationS3Response
Creates a transfer location for an Amazon S3 bucket.
-
#create_location_smb(params = {}) ⇒ Types::CreateLocationSmbResponse
Creates a transfer location for a Server Message Block (SMB) file server.
-
#create_task(params = {}) ⇒ Types::CreateTaskResponse
Configures a task, which defines where and how DataSync transfers your data.
-
#delete_agent(params = {}) ⇒ Struct
Removes an DataSync agent resource from your Amazon Web Services account.
-
#delete_location(params = {}) ⇒ Struct
Deletes a transfer location resource from DataSync.
-
#delete_task(params = {}) ⇒ Struct
Deletes a transfer task resource from DataSync.
-
#describe_agent(params = {}) ⇒ Types::DescribeAgentResponse
Returns information about an DataSync agent, such as its name, service endpoint type, and status.
-
#describe_discovery_job(params = {}) ⇒ Types::DescribeDiscoveryJobResponse
Returns information about a DataSync discovery job.
-
#describe_location_azure_blob(params = {}) ⇒ Types::DescribeLocationAzureBlobResponse
Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
-
#describe_location_efs(params = {}) ⇒ Types::DescribeLocationEfsResponse
Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.
-
#describe_location_fsx_lustre(params = {}) ⇒ Types::DescribeLocationFsxLustreResponse
Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.
-
#describe_location_fsx_ontap(params = {}) ⇒ Types::DescribeLocationFsxOntapResponse
Provides details about how an DataSync transfer 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 transfer location for an Amazon FSx for OpenZFS file system is configured.
-
#describe_location_fsx_windows(params = {}) ⇒ Types::DescribeLocationFsxWindowsResponse
Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.
-
#describe_location_hdfs(params = {}) ⇒ Types::DescribeLocationHdfsResponse
Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.
-
#describe_location_nfs(params = {}) ⇒ Types::DescribeLocationNfsResponse
Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.
-
#describe_location_object_storage(params = {}) ⇒ Types::DescribeLocationObjectStorageResponse
Provides details about how an DataSync transfer location for an object storage system is configured.
-
#describe_location_s3(params = {}) ⇒ Types::DescribeLocationS3Response
Provides details about how an DataSync transfer location for an S3 bucket is configured.
-
#describe_location_smb(params = {}) ⇒ Types::DescribeLocationSmbResponse
Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.
-
#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
Provides information about a task, which defines where and how DataSync transfers your data.
-
#describe_task_execution(params = {}) ⇒ Types::DescribeTaskExecutionResponse
Provides information about an execution of your DataSync task.
-
#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 executions for an DataSync transfer task.
-
#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 transfer 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 DataSync agent.
-
#update_discovery_job(params = {}) ⇒ Struct
Edits a DataSync discovery job configuration.
-
#update_location_azure_blob(params = {}) ⇒ Struct
Modifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
-
#update_location_efs(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Amazon EFS transfer location that you're using with DataSync.
-
#update_location_fsx_lustre(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Amazon FSx for Lustre transfer location that you're using with DataSync.
-
#update_location_fsx_ontap(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync.
-
#update_location_fsx_open_zfs(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync.
-
#update_location_fsx_windows(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync.
-
#update_location_hdfs(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Hadoop Distributed File System (HDFS) transfer location that you're using with DataSync.
-
#update_location_nfs(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Network File System (NFS) transfer location that you're using with DataSync.
-
#update_location_object_storage(params = {}) ⇒ Struct
Modifies the following configuration parameters of the object storage transfer location that you're using with DataSync.
-
#update_location_s3(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Amazon S3 transfer location that you're using with DataSync.
-
#update_location_smb(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Server Message Block (SMB) transfer location that you're using with DataSync.
-
#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 configuration of a task, which defines where and how DataSync transfers your data.
-
#update_task_execution(params = {}) ⇒ Struct
Updates the configuration of a running DataSync task execution.
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.
473 474 475 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 473 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.
560 561 562 563 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 560 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.
592 593 594 595 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 592 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 deploy in your storage environment. The activation process associates the agent with your Amazon Web Services account.
If you haven't deployed an agent yet, see Do I need a DataSync agent?
673 674 675 676 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 673 def create_agent(params = {}, = {}) req = build_request(:create_agent, params) req.send_request() end |
#create_location_azure_blob(params = {}) ⇒ Types::CreateLocationAzureBlobResponse
Creates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location as a transfer source or destination.
Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your container.
778 779 780 781 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 778 def create_location_azure_blob(params = {}, = {}) req = build_request(:create_location_azure_blob, params) req.send_request() end |
#create_location_efs(params = {}) ⇒ Types::CreateLocationEfsResponse
Creates a transfer location for an Amazon EFS file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses Amazon EFS file systems.
886 887 888 889 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 886 def create_location_efs(params = {}, = {}) req = build_request(:create_location_efs, params) req.send_request() end |
#create_location_fsx_lustre(params = {}) ⇒ Types::CreateLocationFsxLustreResponse
Creates a transfer location for an Amazon FSx for Lustre file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for Lustre file systems.
959 960 961 962 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 959 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 a transfer location for an Amazon FSx for NetApp ONTAP file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for ONTAP file systems.
1062 1063 1064 1065 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1062 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 a transfer location for an Amazon FSx for OpenZFS file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for OpenZFS file systems.
SMB
aren't supported with the
CreateLocationFsxOpenZfs
operation.
1145 1146 1147 1148 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1145 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 a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for Windows File Server file systems.
1254 1255 1256 1257 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1254 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 a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses HDFS clusters.
1398 1399 1400 1401 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1398 def create_location_hdfs(params = {}, = {}) req = build_request(:create_location_hdfs, params) req.send_request() end |
#create_location_nfs(params = {}) ⇒ Types::CreateLocationNfsResponse
Creates a transfer location for a Network File System (NFS) file server. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses NFS file servers.
1481 1482 1483 1484 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1481 def create_location_nfs(params = {}, = {}) req = build_request(:create_location_nfs, params) req.send_request() end |
#create_location_object_storage(params = {}) ⇒ Types::CreateLocationObjectStorageResponse
Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand the prerequisites for DataSync to work with object storage systems.
1593 1594 1595 1596 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1593 def create_location_object_storage(params = {}, = {}) req = build_request(:create_location_object_storage, params) req.send_request() end |
#create_location_s3(params = {}) ⇒ Types::CreateLocationS3Response
Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you read the following topics:
For more information, see Configuring transfers with Amazon S3.
1717 1718 1719 1720 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1717 def create_location_s3(params = {}, = {}) req = build_request(:create_location_s3, params) req.send_request() end |
#create_location_smb(params = {}) ⇒ Types::CreateLocationSmbResponse
Creates a transfer location for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses SMB file servers. For more information, see Providing DataSync access to SMB file servers.
1887 1888 1889 1890 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1887 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, destination location, and transfer options (such as bandwidth limits, scheduling, and more).
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
2120 2121 2122 2123 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2120 def create_task(params = {}, = {}) req = build_request(:create_task, params) req.send_request() end |
#delete_agent(params = {}) ⇒ Struct
Removes an DataSync agent resource from your Amazon Web Services account.
Keep in mind that this operation (which can't be undone) doesn't remove the agent's virtual machine (VM) or Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or instance from your storage environment or reuse it to activate a new agent.
2155 2156 2157 2158 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2155 def delete_agent(params = {}, = {}) req = build_request(:delete_agent, params) req.send_request() end |
#delete_location(params = {}) ⇒ Struct
Deletes a transfer location resource from DataSync.
2177 2178 2179 2180 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2177 def delete_location(params = {}, = {}) req = build_request(:delete_location, params) req.send_request() end |
#delete_task(params = {}) ⇒ Struct
Deletes a transfer task resource from DataSync.
2200 2201 2202 2203 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2200 def delete_task(params = {}, = {}) req = build_request(:delete_task, params) req.send_request() end |
#describe_agent(params = {}) ⇒ Types::DescribeAgentResponse
Returns information about an DataSync agent, such as its name, service endpoint type, and status.
2249 2250 2251 2252 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2249 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.
2288 2289 2290 2291 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2288 def describe_discovery_job(params = {}, = {}) req = build_request(:describe_discovery_job, params) req.send_request() end |
#describe_location_azure_blob(params = {}) ⇒ Types::DescribeLocationAzureBlobResponse
Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
2331 2332 2333 2334 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2331 def describe_location_azure_blob(params = {}, = {}) req = build_request(:describe_location_azure_blob, params) req.send_request() end |
#describe_location_efs(params = {}) ⇒ Types::DescribeLocationEfsResponse
Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.
2375 2376 2377 2378 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2375 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 transfer location for an Amazon FSx for Lustre file system is configured.
2412 2413 2414 2415 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2412 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 transfer location for an Amazon FSx for NetApp ONTAP file system is configured.
DescribeLocationFsxOntap
operation
doesn't actually return a Password
.
2464 2465 2466 2467 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2464 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 transfer location for an Amazon FSx for OpenZFS file system is configured.
SMB
aren't supported with the
DescribeLocationFsxOpenZfs
operation.
2512 2513 2514 2515 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2512 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
Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.
2553 2554 2555 2556 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2553 def describe_location_fsx_windows(params = {}, = {}) req = build_request(:describe_location_fsx_windows, params) req.send_request() end |
#describe_location_hdfs(params = {}) ⇒ Types::DescribeLocationHdfsResponse
Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.
2608 2609 2610 2611 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2608 def describe_location_hdfs(params = {}, = {}) req = build_request(:describe_location_hdfs, params) req.send_request() end |
#describe_location_nfs(params = {}) ⇒ Types::DescribeLocationNfsResponse
Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.
2647 2648 2649 2650 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2647 def describe_location_nfs(params = {}, = {}) req = build_request(:describe_location_nfs, params) req.send_request() end |
#describe_location_object_storage(params = {}) ⇒ Types::DescribeLocationObjectStorageResponse
Provides details about how an DataSync transfer location for an object storage system is configured.
2692 2693 2694 2695 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2692 def describe_location_object_storage(params = {}, = {}) req = build_request(:describe_location_object_storage, params) req.send_request() end |
#describe_location_s3(params = {}) ⇒ Types::DescribeLocationS3Response
Provides details about how an DataSync transfer location for an S3 bucket is configured.
2732 2733 2734 2735 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2732 def describe_location_s3(params = {}, = {}) req = build_request(:describe_location_s3, params) req.send_request() end |
#describe_location_smb(params = {}) ⇒ Types::DescribeLocationSmbResponse
Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.
2782 2783 2784 2785 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2782 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.
2832 2833 2834 2835 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2832 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.
2916 2917 2918 2919 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2916 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.
3065 3066 3067 3068 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3065 def describe_storage_system_resources(params = {}, = {}) req = build_request(:describe_storage_system_resources, params) req.send_request() end |
#describe_task(params = {}) ⇒ Types::DescribeTaskResponse
Provides information about a task, which defines where and how DataSync transfers your data.
3170 3171 3172 3173 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3170 def describe_task(params = {}, = {}) req = build_request(:describe_task, params) req.send_request() end |
#describe_task_execution(params = {}) ⇒ Types::DescribeTaskExecutionResponse
Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing data transfer or check the results of the transfer.
DescribeTaskExecution
response elements are only relevant to a
specific task mode. For information, see Understanding task mode
differences and Understanding data transfer performance
counters.
3305 3306 3307 3308 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3305 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.
3350 3351 3352 3353 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3350 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.
3412 3413 3414 3415 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3412 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.
3459 3460 3461 3462 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3459 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.
3516 3517 3518 3519 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3516 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.
3556 3557 3558 3559 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3556 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.
3600 3601 3602 3603 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3600 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_task_executions(params = {}) ⇒ Types::ListTaskExecutionsResponse
Returns a list of executions for an DataSync transfer task.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3645 3646 3647 3648 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3645 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.
3699 3700 3701 3702 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3699 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.
3724 3725 3726 3727 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3724 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.
3789 3790 3791 3792 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3789 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 transfer task. For each task, you can only run one task execution at a time.
There are several steps 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.
3978 3979 3980 3981 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3978 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.
4011 4012 4013 4014 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4011 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.
4047 4048 4049 4050 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4047 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.
4074 4075 4076 4077 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4074 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_agent(params = {}) ⇒ Struct
Updates the name of an DataSync agent.
4100 4101 4102 4103 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4100 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.
4129 4130 4131 4132 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4129 def update_discovery_job(params = {}, = {}) req = build_request(:update_discovery_job, params) req.send_request() end |
#update_location_azure_blob(params = {}) ⇒ Struct
Modifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with Azure Blob Storage.
4212 4213 4214 4215 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4212 def update_location_azure_blob(params = {}, = {}) req = build_request(:update_location_azure_blob, params) req.send_request() end |
#update_location_efs(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Amazon EFS transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with Amazon EFS.
4291 4292 4293 4294 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4291 def update_location_efs(params = {}, = {}) req = build_request(:update_location_efs, params) req.send_request() end |
#update_location_fsx_lustre(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Amazon FSx for Lustre transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with FSx for Lustre.
4332 4333 4334 4335 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4332 def update_location_fsx_lustre(params = {}, = {}) req = build_request(:update_location_fsx_lustre, params) req.send_request() end |
#update_location_fsx_ontap(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with FSx for ONTAP.
4402 4403 4404 4405 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4402 def update_location_fsx_ontap(params = {}, = {}) req = build_request(:update_location_fsx_ontap, params) req.send_request() end |
#update_location_fsx_open_zfs(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with FSx for OpenZFS.
SMB
aren't supported with the
UpdateLocationFsxOpenZfs
operation.
4464 4465 4466 4467 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4464 def update_location_fsx_open_zfs(params = {}, = {}) req = build_request(:update_location_fsx_open_zfs, params) req.send_request() end |
#update_location_fsx_windows(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with FSx for Windows File Server.
4531 4532 4533 4534 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4531 def update_location_fsx_windows(params = {}, = {}) req = build_request(:update_location_fsx_windows, params) req.send_request() end |
#update_location_hdfs(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Hadoop Distributed File System (HDFS) transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with an HDFS cluster.
4635 4636 4637 4638 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4635 def update_location_hdfs(params = {}, = {}) req = build_request(:update_location_hdfs, params) req.send_request() end |
#update_location_nfs(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Network File System (NFS) transfer location that you're using with DataSync.
For more information, see Configuring transfers with an NFS file server.
4697 4698 4699 4700 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4697 def update_location_nfs(params = {}, = {}) req = build_request(:update_location_nfs, params) req.send_request() end |
#update_location_object_storage(params = {}) ⇒ Struct
Modifies the following configuration parameters of the object storage transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with an object storage system.
4794 4795 4796 4797 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4794 def update_location_object_storage(params = {}, = {}) req = build_request(:update_location_object_storage, params) req.send_request() end |
#update_location_s3(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Amazon S3 transfer location that you're using with DataSync.
Before you begin, make sure that you read the following topics:
4878 4879 4880 4881 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4878 def update_location_s3(params = {}, = {}) req = build_request(:update_location_s3, params) req.send_request() end |
#update_location_smb(params = {}) ⇒ Struct
Modifies the following configuration parameters of the Server Message Block (SMB) transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with an SMB file server.
5033 5034 5035 5036 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 5033 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.
5088 5089 5090 5091 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 5088 def update_storage_system(params = {}, = {}) req = build_request(:update_storage_system, params) req.send_request() end |
#update_task(params = {}) ⇒ Struct
Updates the configuration of a task, which defines where and how DataSync transfers your data.
5283 5284 5285 5286 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 5283 def update_task(params = {}, = {}) req = build_request(:update_task, params) req.send_request() end |
#update_task_execution(params = {}) ⇒ Struct
Updates the configuration of a running DataSync task execution.
Option
that you can modify with
UpdateTaskExecution
is BytesPerSecond
, which throttles bandwidth
for a running or queued task execution.
5346 5347 5348 5349 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 5346 def update_task_execution(params = {}, = {}) req = build_request(:update_task_execution, params) req.send_request() end |