Class: Aws::DataSync::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DataSync::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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 an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or destination.
-
#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
Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.
-
#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 use for a data transfer.
-
#create_task(params = {}) ⇒ Types::CreateTaskResponse
Configures a transfer task, which defines where and how DataSync moves 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 transfer 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_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
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
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
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
Provides information about an DataSync transfer task.
-
#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 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 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 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 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 configuration of a DataSync transfer task.
-
#update_task_execution(params = {}) ⇒ Struct
Updates the configuration of a running DataSync task execution.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
395 396 397 |
# File 'lib/aws-sdk-datasync/client.rb', line 395 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4385 4386 4387 |
# File 'lib/aws-sdk-datasync/client.rb', line 4385 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4388 4389 4390 |
# File 'lib/aws-sdk-datasync/client.rb', line 4388 def errors_module Errors 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.
482 483 484 485 |
# File 'lib/aws-sdk-datasync/client.rb', line 482 def add_storage_system(params = {}, = {}) req = build_request(:add_storage_system, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 |
# File 'lib/aws-sdk-datasync/client.rb', line 4363 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-datasync' context[:gem_version] = '1.67.0' Seahorse::Client::Request.new(handlers, context) 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.
514 515 516 517 |
# File 'lib/aws-sdk-datasync/client.rb', line 514 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:
- Agent requirements][1
- Create an agent][2
<note markdown=“1”> If you’re transferring between Amazon Web Services storage services, you don’t need a DataSync agent.
</note>
[1]: docs.aws.amazon.com/datasync/latest/userguide/agent-requirements.html [2]: docs.aws.amazon.com/datasync/latest/userguide/configure-agent.html
613 614 615 616 |
# File 'lib/aws-sdk-datasync/client.rb', line 613 def create_agent(params = {}, = {}) req = build_request(:create_agent, params) req.send_request() end |
#create_location_azure_blob(params = {}) ⇒ Types::CreateLocationAzureBlobResponse
Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use 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.
[1]: docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access [2]: docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers [3]: docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types [4]: docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent
717 718 719 720 |
# File 'lib/aws-sdk-datasync/client.rb', line 717 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 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].
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html
803 804 805 806 |
# File 'lib/aws-sdk-datasync/client.rb', line 803 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.
854 855 856 857 |
# File 'lib/aws-sdk-datasync/client.rb', line 854 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].
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html
954 955 956 957 |
# File 'lib/aws-sdk-datasync/client.rb', line 954 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].
<note markdown=“1”> Request parameters related to ‘SMB` aren’t supported with the ‘CreateLocationFsxOpenZfs` operation.
</note>
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html
1034 1035 1036 1037 |
# File 'lib/aws-sdk-datasync/client.rb', line 1034 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.
1119 1120 1121 1122 |
# File 'lib/aws-sdk-datasync/client.rb', line 1119 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).
1254 1255 1256 1257 |
# File 'lib/aws-sdk-datasync/client.rb', line 1254 def create_location_hdfs(params = {}, = {}) req = build_request(:create_location_hdfs, params) req.send_request() end |
#create_location_nfs(params = {}) ⇒ Types::CreateLocationNfsResponse
Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.
For more information, see [Configuring transfers to or from an NFS file server].
<note markdown=“1”> If you’re copying data to or from an Snowcone device, you can also use ‘CreateLocationNfs` to create your transfer location. For more information, see [Configuring transfers with Snowcone].
</note>
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html [2]: docs.aws.amazon.com/datasync/latest/userguide/nfs-on-snowcone.html
1343 1344 1345 1346 |
# File 'lib/aws-sdk-datasync/client.rb', line 1343 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].
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html
1446 1447 1448 1449 |
# File 'lib/aws-sdk-datasync/client.rb', line 1446 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:
* [Storage class considerations with Amazon S3 locations][1]
- Evaluating S3 request costs when using DataSync][2
For more information, see [Creating an Amazon S3 location].
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes [2]: docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests [3]: docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli
1548 1549 1550 1551 |
# File 'lib/aws-sdk-datasync/client.rb', line 1548 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 use for a data transfer.
Before you begin, make sure that you understand how DataSync [accesses an SMB file server].
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html
1663 1664 1665 1666 |
# File 'lib/aws-sdk-datasync/client.rb', line 1663 def create_location_smb(params = {}, = {}) req = build_request(:create_location_smb, params) req.send_request() end |
#create_task(params = {}) ⇒ Types::CreateTaskResponse
Configures a transfer task, which defines where and how DataSync moves your data.
A task includes a source location, destination location, and the options 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][2
-
before you begin.
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests [2]: aws.amazon.com/datasync/pricing/
1834 1835 1836 1837 |
# File 'lib/aws-sdk-datasync/client.rb', line 1834 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.
1862 1863 1864 1865 |
# File 'lib/aws-sdk-datasync/client.rb', line 1862 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.
1884 1885 1886 1887 |
# File 'lib/aws-sdk-datasync/client.rb', line 1884 def delete_location(params = {}, = {}) req = build_request(:delete_location, params) req.send_request() end |
#delete_task(params = {}) ⇒ Struct
Deletes an DataSync transfer task.
1907 1908 1909 1910 |
# File 'lib/aws-sdk-datasync/client.rb', line 1907 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.
1954 1955 1956 1957 |
# File 'lib/aws-sdk-datasync/client.rb', line 1954 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.
1993 1994 1995 1996 |
# File 'lib/aws-sdk-datasync/client.rb', line 1993 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.
2036 2037 2038 2039 |
# File 'lib/aws-sdk-datasync/client.rb', line 2036 def describe_location_azure_blob(params = {}, = {}) req = build_request(:describe_location_azure_blob, params) req.send_request() end |
#describe_location_efs(params = {}) ⇒ Types::DescribeLocationEfsResponse
Returns metadata about your DataSync location for an Amazon EFS file system.
2080 2081 2082 2083 |
# File 'lib/aws-sdk-datasync/client.rb', line 2080 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.
2117 2118 2119 2120 |
# File 'lib/aws-sdk-datasync/client.rb', line 2117 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.
<note markdown=“1”> If your location uses SMB, the ‘DescribeLocationFsxOntap` operation doesn’t actually return a ‘Password`.
</note>
2169 2170 2171 2172 |
# File 'lib/aws-sdk-datasync/client.rb', line 2169 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.
<note markdown=“1”> Response elements related to ‘SMB` aren’t supported with the ‘DescribeLocationFsxOpenZfs` operation.
</note>
2217 2218 2219 2220 |
# File 'lib/aws-sdk-datasync/client.rb', line 2217 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.
2258 2259 2260 2261 |
# File 'lib/aws-sdk-datasync/client.rb', line 2258 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.
2314 2315 2316 2317 |
# File 'lib/aws-sdk-datasync/client.rb', line 2314 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.
2353 2354 2355 2356 |
# File 'lib/aws-sdk-datasync/client.rb', line 2353 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.
2398 2399 2400 2401 |
# File 'lib/aws-sdk-datasync/client.rb', line 2398 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.
2439 2440 2441 2442 |
# File 'lib/aws-sdk-datasync/client.rb', line 2439 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.
2481 2482 2483 2484 |
# File 'lib/aws-sdk-datasync/client.rb', line 2481 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.
2531 2532 2533 2534 |
# File 'lib/aws-sdk-datasync/client.rb', line 2531 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.
2615 2616 2617 2618 |
# File 'lib/aws-sdk-datasync/client.rb', line 2615 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.
2764 2765 2766 2767 |
# File 'lib/aws-sdk-datasync/client.rb', line 2764 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 an DataSync transfer task.
2853 2854 2855 2856 |
# File 'lib/aws-sdk-datasync/client.rb', line 2853 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.
2957 2958 2959 2960 |
# File 'lib/aws-sdk-datasync/client.rb', line 2957 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][2
-
operation.
[1]: docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html [2]: docs.aws.amazon.com/datasync/latest/userguide/API_DescribeStorageSystemResources.html
3002 3003 3004 3005 |
# File 'lib/aws-sdk-datasync/client.rb', line 3002 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][1
-
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].
[1]: docs.aws.amazon.com/datasync/latest/userguide/API_CreateAgent.html [2]: docs.aws.amazon.com/datasync/latest/userguide/API_DescribeAgent.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3063 3064 3065 3066 |
# File 'lib/aws-sdk-datasync/client.rb', line 3063 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.
3110 3111 3112 3113 |
# File 'lib/aws-sdk-datasync/client.rb', line 3110 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.
3167 3168 3169 3170 |
# File 'lib/aws-sdk-datasync/client.rb', line 3167 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.
3207 3208 3209 3210 |
# File 'lib/aws-sdk-datasync/client.rb', line 3207 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.
3251 3252 3253 3254 |
# File 'lib/aws-sdk-datasync/client.rb', line 3251 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.
3295 3296 3297 3298 |
# File 'lib/aws-sdk-datasync/client.rb', line 3295 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.
3348 3349 3350 3351 |
# File 'lib/aws-sdk-datasync/client.rb', line 3348 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.
3373 3374 3375 3376 |
# File 'lib/aws-sdk-datasync/client.rb', line 3373 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.
[1]: docs.aws.amazon.com/datasync/latest/userguide/API_AddStorageSystem.html
3438 3439 3440 3441 |
# File 'lib/aws-sdk-datasync/client.rb', line 3438 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][3
-
before you begin.
[1]: docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses [2]: docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests [3]: aws.amazon.com/datasync/pricing/
3575 3576 3577 3578 |
# File 'lib/aws-sdk-datasync/client.rb', line 3575 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.
[1]: docs.aws.amazon.com/datasync/latest/userguide/API_GenerateRecommendations.html
3608 3609 3610 3611 |
# File 'lib/aws-sdk-datasync/client.rb', line 3608 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.
3644 3645 3646 3647 |
# File 'lib/aws-sdk-datasync/client.rb', line 3644 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.
3671 3672 3673 3674 |
# File 'lib/aws-sdk-datasync/client.rb', line 3671 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_agent(params = {}) ⇒ Struct
Updates the name of an agent.
3697 3698 3699 3700 |
# File 'lib/aws-sdk-datasync/client.rb', line 3697 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.
3726 3727 3728 3729 |
# File 'lib/aws-sdk-datasync/client.rb', line 3726 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.
3802 3803 3804 3805 |
# File 'lib/aws-sdk-datasync/client.rb', line 3802 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.
3897 3898 3899 3900 |
# File 'lib/aws-sdk-datasync/client.rb', line 3897 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].
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html
3954 3955 3956 3957 |
# File 'lib/aws-sdk-datasync/client.rb', line 3954 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].
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html
4029 4030 4031 4032 |
# File 'lib/aws-sdk-datasync/client.rb', line 4029 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].
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html
4111 4112 4113 4114 |
# File 'lib/aws-sdk-datasync/client.rb', line 4111 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.
4166 4167 4168 4169 |
# File 'lib/aws-sdk-datasync/client.rb', line 4166 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 DataSync transfer task.
4299 4300 4301 4302 |
# File 'lib/aws-sdk-datasync/client.rb', line 4299 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.
<note markdown=“1”> Currently, the only ‘Option` that you can modify with `UpdateTaskExecution` is ` BytesPerSecond `, which throttles bandwidth for a running or queued task execution.
</note>
4354 4355 4356 4357 |
# File 'lib/aws-sdk-datasync/client.rb', line 4354 def update_task_execution(params = {}, = {}) req = build_request(:update_task_execution, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4378 4379 4380 |
# File 'lib/aws-sdk-datasync/client.rb', line 4378 def waiter_names [] end |