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 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.
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.
420 421 422 |
# File 'lib/aws-sdk-datasync/client.rb', line 420 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.
4669 4670 4671 |
# File 'lib/aws-sdk-datasync/client.rb', line 4669 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.
4672 4673 4674 |
# File 'lib/aws-sdk-datasync/client.rb', line 4672 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.
507 508 509 510 |
# File 'lib/aws-sdk-datasync/client.rb', line 507 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.
4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 |
# File 'lib/aws-sdk-datasync/client.rb', line 4647 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.81.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.
539 540 541 542 |
# File 'lib/aws-sdk-datasync/client.rb', line 539 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
638 639 640 641 |
# File 'lib/aws-sdk-datasync/client.rb', line 638 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.
[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
743 744 745 746 |
# File 'lib/aws-sdk-datasync/client.rb', line 743 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].
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-access
832 833 834 835 |
# File 'lib/aws-sdk-datasync/client.rb', line 832 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].
892 893 894 895 |
# File 'lib/aws-sdk-datasync/client.rb', line 892 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].
995 996 997 998 |
# File 'lib/aws-sdk-datasync/client.rb', line 995 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].
<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#create-openzfs-access
1078 1079 1080 1081 |
# File 'lib/aws-sdk-datasync/client.rb', line 1078 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].
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-location-access
1178 1179 1180 1181 |
# File 'lib/aws-sdk-datasync/client.rb', line 1178 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].
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html#accessing-hdfs
1322 1323 1324 1325 |
# File 'lib/aws-sdk-datasync/client.rb', line 1322 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].
<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#accessing-nfs [2]: docs.aws.amazon.com/datasync/latest/userguide/nfs-on-snowcone.html
1412 1413 1414 1415 |
# File 'lib/aws-sdk-datasync/client.rb', line 1412 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.
1525 1526 1527 1528 |
# File 'lib/aws-sdk-datasync/client.rb', line 1525 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:
* [Storage class considerations with Amazon S3 locations][1]
- Evaluating S3 request costs when using DataSync][2
For more information, see [Configuring transfers with Amazon S3].
[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-s3-location.html
1648 1649 1650 1651 |
# File 'lib/aws-sdk-datasync/client.rb', line 1648 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].
[1]: docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb
1762 1763 1764 1765 |
# File 'lib/aws-sdk-datasync/client.rb', line 1762 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][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/
1961 1962 1963 1964 |
# File 'lib/aws-sdk-datasync/client.rb', line 1961 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].
[1]: docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html
1996 1997 1998 1999 |
# File 'lib/aws-sdk-datasync/client.rb', line 1996 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.
2018 2019 2020 2021 |
# File 'lib/aws-sdk-datasync/client.rb', line 2018 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.
2041 2042 2043 2044 |
# File 'lib/aws-sdk-datasync/client.rb', line 2041 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.
2090 2091 2092 2093 |
# File 'lib/aws-sdk-datasync/client.rb', line 2090 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.
2129 2130 2131 2132 |
# File 'lib/aws-sdk-datasync/client.rb', line 2129 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.
2172 2173 2174 2175 |
# File 'lib/aws-sdk-datasync/client.rb', line 2172 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.
2216 2217 2218 2219 |
# File 'lib/aws-sdk-datasync/client.rb', line 2216 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.
2253 2254 2255 2256 |
# File 'lib/aws-sdk-datasync/client.rb', line 2253 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.
<note markdown=“1”> If your location uses SMB, the ‘DescribeLocationFsxOntap` operation doesn’t actually return a ‘Password`.
</note>
2305 2306 2307 2308 |
# File 'lib/aws-sdk-datasync/client.rb', line 2305 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.
<note markdown=“1”> Response elements related to ‘SMB` aren’t supported with the ‘DescribeLocationFsxOpenZfs` operation.
</note>
2353 2354 2355 2356 |
# File 'lib/aws-sdk-datasync/client.rb', line 2353 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.
2394 2395 2396 2397 |
# File 'lib/aws-sdk-datasync/client.rb', line 2394 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.
2449 2450 2451 2452 |
# File 'lib/aws-sdk-datasync/client.rb', line 2449 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.
2488 2489 2490 2491 |
# File 'lib/aws-sdk-datasync/client.rb', line 2488 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.
2533 2534 2535 2536 |
# File 'lib/aws-sdk-datasync/client.rb', line 2533 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.
2573 2574 2575 2576 |
# File 'lib/aws-sdk-datasync/client.rb', line 2573 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.
2616 2617 2618 2619 |
# File 'lib/aws-sdk-datasync/client.rb', line 2616 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.
2666 2667 2668 2669 |
# File 'lib/aws-sdk-datasync/client.rb', line 2666 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.
2750 2751 2752 2753 |
# File 'lib/aws-sdk-datasync/client.rb', line 2750 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.
2899 2900 2901 2902 |
# File 'lib/aws-sdk-datasync/client.rb', line 2899 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.
3002 3003 3004 3005 |
# File 'lib/aws-sdk-datasync/client.rb', line 3002 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.
3113 3114 3115 3116 |
# File 'lib/aws-sdk-datasync/client.rb', line 3113 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
3158 3159 3160 3161 |
# File 'lib/aws-sdk-datasync/client.rb', line 3158 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.
3220 3221 3222 3223 |
# File 'lib/aws-sdk-datasync/client.rb', line 3220 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.
3267 3268 3269 3270 |
# File 'lib/aws-sdk-datasync/client.rb', line 3267 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.
3324 3325 3326 3327 |
# File 'lib/aws-sdk-datasync/client.rb', line 3324 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.
3364 3365 3366 3367 |
# File 'lib/aws-sdk-datasync/client.rb', line 3364 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.
3408 3409 3410 3411 |
# File 'lib/aws-sdk-datasync/client.rb', line 3408 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.
3452 3453 3454 3455 |
# File 'lib/aws-sdk-datasync/client.rb', line 3452 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.
3505 3506 3507 3508 |
# File 'lib/aws-sdk-datasync/client.rb', line 3505 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.
3530 3531 3532 3533 |
# File 'lib/aws-sdk-datasync/client.rb', line 3530 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
3595 3596 3597 3598 |
# File 'lib/aws-sdk-datasync/client.rb', line 3595 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/
3784 3785 3786 3787 |
# File 'lib/aws-sdk-datasync/client.rb', line 3784 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
3817 3818 3819 3820 |
# File 'lib/aws-sdk-datasync/client.rb', line 3817 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.
3853 3854 3855 3856 |
# File 'lib/aws-sdk-datasync/client.rb', line 3853 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.
3880 3881 3882 3883 |
# File 'lib/aws-sdk-datasync/client.rb', line 3880 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.
3906 3907 3908 3909 |
# File 'lib/aws-sdk-datasync/client.rb', line 3906 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.
3935 3936 3937 3938 |
# File 'lib/aws-sdk-datasync/client.rb', line 3935 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.
4011 4012 4013 4014 |
# File 'lib/aws-sdk-datasync/client.rb', line 4011 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.
4106 4107 4108 4109 |
# File 'lib/aws-sdk-datasync/client.rb', line 4106 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
4163 4164 4165 4166 |
# File 'lib/aws-sdk-datasync/client.rb', line 4163 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.
4248 4249 4250 4251 |
# File 'lib/aws-sdk-datasync/client.rb', line 4248 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.
4337 4338 4339 4340 |
# File 'lib/aws-sdk-datasync/client.rb', line 4337 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.
4392 4393 4394 4395 |
# File 'lib/aws-sdk-datasync/client.rb', line 4392 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.
4575 4576 4577 4578 |
# File 'lib/aws-sdk-datasync/client.rb', line 4575 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>
4638 4639 4640 4641 |
# File 'lib/aws-sdk-datasync/client.rb', line 4638 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.
4662 4663 4664 |
# File 'lib/aws-sdk-datasync/client.rb', line 4662 def waiter_names [] end |