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've deployed 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 some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
-
#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
Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.
-
#update_location_object_storage(params = {}) ⇒ Struct
Updates some parameters of an existing DataSync location for an object storage system.
-
#update_location_smb(params = {}) ⇒ Struct
Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.
-
#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.
419 420 421 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 419 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.
506 507 508 509 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 506 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.
538 539 540 541 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 538 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've deployed in your storage environment. The activation process associates the agent with your Amazon Web Services account.
If you haven't deployed an agent yet, see the following topics to learn more:
637 638 639 640 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 637 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.
742 743 744 745 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 742 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.
831 832 833 834 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 831 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.
891 892 893 894 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 891 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.
994 995 996 997 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 994 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.
1077 1078 1079 1080 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1077 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.
1177 1178 1179 1180 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1177 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.
1321 1322 1323 1324 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1321 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.
CreateLocationNfs
to create your transfer location. For more
information, see Configuring transfers with Snowcone.
1411 1412 1413 1414 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1411 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.
1524 1525 1526 1527 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1524 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.
1647 1648 1649 1650 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1647 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.
1761 1762 1763 1764 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1761 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.
1960 1961 1962 1963 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1960 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.
1995 1996 1997 1998 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 1995 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.
2017 2018 2019 2020 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2017 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.
2040 2041 2042 2043 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2040 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.
2089 2090 2091 2092 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2089 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.
2128 2129 2130 2131 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2128 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.
2171 2172 2173 2174 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2171 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.
2215 2216 2217 2218 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2215 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.
2252 2253 2254 2255 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2252 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
.
2304 2305 2306 2307 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2304 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.
2352 2353 2354 2355 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2352 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.
2393 2394 2395 2396 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2393 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.
2448 2449 2450 2451 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2448 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.
2487 2488 2489 2490 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2487 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.
2532 2533 2534 2535 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2532 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.
2572 2573 2574 2575 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2572 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.
2615 2616 2617 2618 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2615 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.
2665 2666 2667 2668 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2665 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.
2749 2750 2751 2752 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2749 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.
2898 2899 2900 2901 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 2898 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.
3001 3002 3003 3004 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3001 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 transfer or check the results of the transfer.
3112 3113 3114 3115 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3112 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.
3157 3158 3159 3160 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3157 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.
3219 3220 3221 3222 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3219 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.
3266 3267 3268 3269 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3266 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.
3323 3324 3325 3326 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3323 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.
3363 3364 3365 3366 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3363 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.
3407 3408 3409 3410 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3407 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.
3451 3452 3453 3454 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3451 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.
3504 3505 3506 3507 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3504 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.
3529 3530 3531 3532 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3529 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.
3594 3595 3596 3597 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3594 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 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.
3783 3784 3785 3786 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3783 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.
3816 3817 3818 3819 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3816 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.
3852 3853 3854 3855 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3852 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.
3879 3880 3881 3882 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3879 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.
3905 3906 3907 3908 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3905 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.
3934 3935 3936 3937 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 3934 def update_discovery_job(params = {}, = {}) req = build_request(:update_discovery_job, params) req.send_request() end |
#update_location_azure_blob(params = {}) ⇒ Struct
Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
4010 4011 4012 4013 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4010 def update_location_azure_blob(params = {}, = {}) req = build_request(:update_location_azure_blob, 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.
4105 4106 4107 4108 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4105 def update_location_hdfs(params = {}, = {}) req = build_request(:update_location_hdfs, params) req.send_request() end |
#update_location_nfs(params = {}) ⇒ Struct
Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.
For more information, see Configuring transfers to or from an NFS file server.
4162 4163 4164 4165 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4162 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 DataSync location for an object storage system.
4247 4248 4249 4250 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4247 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 Server Message Block (SMB) file server location that you can use for DataSync transfers.
4336 4337 4338 4339 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4336 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.
4391 4392 4393 4394 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4391 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.
4574 4575 4576 4577 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4574 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.
4637 4638 4639 4640 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/client.rb', line 4637 def update_task_execution(params = {}, = {}) req = build_request(:update_task_execution, params) req.send_request() end |