aws-sdk-datasync 1.55.0 → 1.56.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-datasync/client.rb +786 -20
- data/lib/aws-sdk-datasync/client_api.rb +541 -0
- data/lib/aws-sdk-datasync/endpoints.rb +182 -0
- data/lib/aws-sdk-datasync/plugins/endpoints.rb +26 -0
- data/lib/aws-sdk-datasync/types.rb +1354 -46
- data/lib/aws-sdk-datasync.rb +2 -2
- metadata +2 -2
@@ -378,6 +378,92 @@ module Aws::DataSync
|
|
378
378
|
|
379
379
|
# @!group API Operations
|
380
380
|
|
381
|
+
# Creates an Amazon Web Services resource for an on-premises storage
|
382
|
+
# system that you want DataSync Discovery to collect information about.
|
383
|
+
#
|
384
|
+
# @option params [required, Types::DiscoveryServerConfiguration] :server_configuration
|
385
|
+
# Specifies the server name and network port required to connect with
|
386
|
+
# the management interface of your on-premises storage system.
|
387
|
+
#
|
388
|
+
# @option params [required, String] :system_type
|
389
|
+
# Specifies the type of on-premises storage system that you want
|
390
|
+
# DataSync Discovery to collect information about.
|
391
|
+
#
|
392
|
+
# <note markdown="1"> DataSync Discovery currently supports NetApp Fabric-Attached Storage
|
393
|
+
# (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
|
394
|
+
#
|
395
|
+
# </note>
|
396
|
+
#
|
397
|
+
# @option params [required, Array<String>] :agent_arns
|
398
|
+
# Specifies the Amazon Resource Name (ARN) of the DataSync agent that
|
399
|
+
# connects to and reads from your on-premises storage system's
|
400
|
+
# management interface.
|
401
|
+
#
|
402
|
+
# @option params [String] :cloud_watch_log_group_arn
|
403
|
+
# Specifies the ARN of the Amazon CloudWatch log group for monitoring
|
404
|
+
# and logging discovery job events.
|
405
|
+
#
|
406
|
+
# @option params [Array<Types::TagListEntry>] :tags
|
407
|
+
# Specifies labels that help you categorize, filter, and search for your
|
408
|
+
# Amazon Web Services resources. We recommend creating at least a name
|
409
|
+
# tag for your on-premises storage system.
|
410
|
+
#
|
411
|
+
# @option params [String] :name
|
412
|
+
# Specifies a familiar name for your on-premises storage system.
|
413
|
+
#
|
414
|
+
# @option params [required, String] :client_token
|
415
|
+
# Specifies a client token to make sure requests with this API operation
|
416
|
+
# are idempotent. If you don't specify a client token, DataSync
|
417
|
+
# generates one for you automatically.
|
418
|
+
#
|
419
|
+
# **A suitable default value is auto-generated.** You should normally
|
420
|
+
# not need to pass this option.**
|
421
|
+
#
|
422
|
+
# @option params [required, Types::Credentials] :credentials
|
423
|
+
# Specifies the user name and password for accessing your on-premises
|
424
|
+
# storage system's management interface.
|
425
|
+
#
|
426
|
+
# @return [Types::AddStorageSystemResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
427
|
+
#
|
428
|
+
# * {Types::AddStorageSystemResponse#storage_system_arn #storage_system_arn} => String
|
429
|
+
#
|
430
|
+
# @example Request syntax with placeholder values
|
431
|
+
#
|
432
|
+
# resp = client.add_storage_system({
|
433
|
+
# server_configuration: { # required
|
434
|
+
# server_hostname: "DiscoveryServerHostname", # required
|
435
|
+
# server_port: 1,
|
436
|
+
# },
|
437
|
+
# system_type: "NetAppONTAP", # required, accepts NetAppONTAP
|
438
|
+
# agent_arns: ["AgentArn"], # required
|
439
|
+
# cloud_watch_log_group_arn: "LogGroupArn",
|
440
|
+
# tags: [
|
441
|
+
# {
|
442
|
+
# key: "TagKey", # required
|
443
|
+
# value: "TagValue",
|
444
|
+
# },
|
445
|
+
# ],
|
446
|
+
# name: "Name",
|
447
|
+
# client_token: "PtolemyUUID", # required
|
448
|
+
# credentials: { # required
|
449
|
+
# username: "PtolemyUsername", # required
|
450
|
+
# password: "PtolemyPassword", # required
|
451
|
+
# },
|
452
|
+
# })
|
453
|
+
#
|
454
|
+
# @example Response structure
|
455
|
+
#
|
456
|
+
# resp.storage_system_arn #=> String
|
457
|
+
#
|
458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/AddStorageSystem AWS API Documentation
|
459
|
+
#
|
460
|
+
# @overload add_storage_system(params = {})
|
461
|
+
# @param [Hash] params ({})
|
462
|
+
def add_storage_system(params = {}, options = {})
|
463
|
+
req = build_request(:add_storage_system, params)
|
464
|
+
req.send_request(options)
|
465
|
+
end
|
466
|
+
|
381
467
|
# Stops an DataSync task execution that's in progress. The transfer of
|
382
468
|
# some files are abruptly interrupted. File contents that're
|
383
469
|
# transferred to the destination might be incomplete or inconsistent
|
@@ -681,9 +767,9 @@ module Aws::DataSync
|
|
681
767
|
# The security groups must allow outbound traffic on the following ports
|
682
768
|
# (depending on the protocol you use):
|
683
769
|
#
|
684
|
-
# * **Network File System (NFS)
|
770
|
+
# * **Network File System (NFS)**: TCP ports 111, 635, and 2049
|
685
771
|
#
|
686
|
-
# * **Server Message Block (SMB)
|
772
|
+
# * **Server Message Block (SMB)**: TCP port 445
|
687
773
|
#
|
688
774
|
# Your file system's security groups must also allow inbound traffic on
|
689
775
|
# the same ports.
|
@@ -1260,13 +1346,23 @@ module Aws::DataSync
|
|
1260
1346
|
req.send_request(options)
|
1261
1347
|
end
|
1262
1348
|
|
1263
|
-
#
|
1264
|
-
#
|
1265
|
-
#
|
1349
|
+
# A *location* is an endpoint for an Amazon S3 bucket. DataSync can use
|
1350
|
+
# the location as a source or destination for copying data.
|
1351
|
+
#
|
1352
|
+
# Before you create your location, make sure that you read the following
|
1353
|
+
# sections:
|
1354
|
+
#
|
1355
|
+
# * [Storage class considerations with Amazon S3 locations][1]
|
1356
|
+
#
|
1357
|
+
# * [Evaluating S3 request costs when using DataSync][2]
|
1358
|
+
#
|
1359
|
+
# For more information, see [Creating an Amazon S3 location][3].
|
1266
1360
|
#
|
1267
1361
|
#
|
1268
1362
|
#
|
1269
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-
|
1363
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
|
1364
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests
|
1365
|
+
# [3]: https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli
|
1270
1366
|
#
|
1271
1367
|
# @option params [String] :subdirectory
|
1272
1368
|
# A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3
|
@@ -1472,6 +1568,15 @@ module Aws::DataSync
|
|
1472
1568
|
# preferences for how and when you want to transfer your data (such as
|
1473
1569
|
# bandwidth limits, scheduling, among other options).
|
1474
1570
|
#
|
1571
|
+
# If you're planning to transfer data to or from an Amazon S3 location,
|
1572
|
+
# review [how DataSync can affect your S3 request charges][1] and the
|
1573
|
+
# [DataSync pricing page][2] before you begin.
|
1574
|
+
#
|
1575
|
+
#
|
1576
|
+
#
|
1577
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests
|
1578
|
+
# [2]: http://aws.amazon.com/datasync/pricing/
|
1579
|
+
#
|
1475
1580
|
# @option params [required, String] :source_location_arn
|
1476
1581
|
# The Amazon Resource Name (ARN) of the source location for the task.
|
1477
1582
|
#
|
@@ -1717,6 +1822,45 @@ module Aws::DataSync
|
|
1717
1822
|
req.send_request(options)
|
1718
1823
|
end
|
1719
1824
|
|
1825
|
+
# Returns information about a DataSync discovery job.
|
1826
|
+
#
|
1827
|
+
# @option params [required, String] :discovery_job_arn
|
1828
|
+
# Specifies the Amazon Resource Name (ARN) of the discovery job that you
|
1829
|
+
# want information about.
|
1830
|
+
#
|
1831
|
+
# @return [Types::DescribeDiscoveryJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1832
|
+
#
|
1833
|
+
# * {Types::DescribeDiscoveryJobResponse#storage_system_arn #storage_system_arn} => String
|
1834
|
+
# * {Types::DescribeDiscoveryJobResponse#discovery_job_arn #discovery_job_arn} => String
|
1835
|
+
# * {Types::DescribeDiscoveryJobResponse#collection_duration_minutes #collection_duration_minutes} => Integer
|
1836
|
+
# * {Types::DescribeDiscoveryJobResponse#status #status} => String
|
1837
|
+
# * {Types::DescribeDiscoveryJobResponse#job_start_time #job_start_time} => Time
|
1838
|
+
# * {Types::DescribeDiscoveryJobResponse#job_end_time #job_end_time} => Time
|
1839
|
+
#
|
1840
|
+
# @example Request syntax with placeholder values
|
1841
|
+
#
|
1842
|
+
# resp = client.describe_discovery_job({
|
1843
|
+
# discovery_job_arn: "DiscoveryJobArn", # required
|
1844
|
+
# })
|
1845
|
+
#
|
1846
|
+
# @example Response structure
|
1847
|
+
#
|
1848
|
+
# resp.storage_system_arn #=> String
|
1849
|
+
# resp.discovery_job_arn #=> String
|
1850
|
+
# resp.collection_duration_minutes #=> Integer
|
1851
|
+
# resp.status #=> String, one of "RUNNING", "WARNING", "TERMINATED", "FAILED", "STOPPED", "COMPLETED", "COMPLETED_WITH_ISSUES"
|
1852
|
+
# resp.job_start_time #=> Time
|
1853
|
+
# resp.job_end_time #=> Time
|
1854
|
+
#
|
1855
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeDiscoveryJob AWS API Documentation
|
1856
|
+
#
|
1857
|
+
# @overload describe_discovery_job(params = {})
|
1858
|
+
# @param [Hash] params ({})
|
1859
|
+
def describe_discovery_job(params = {}, options = {})
|
1860
|
+
req = build_request(:describe_discovery_job, params)
|
1861
|
+
req.send_request(options)
|
1862
|
+
end
|
1863
|
+
|
1720
1864
|
# Returns metadata about your DataSync location for an Amazon EFS file
|
1721
1865
|
# system.
|
1722
1866
|
#
|
@@ -2160,6 +2304,284 @@ module Aws::DataSync
|
|
2160
2304
|
req.send_request(options)
|
2161
2305
|
end
|
2162
2306
|
|
2307
|
+
# Returns information about an on-premises storage system that you're
|
2308
|
+
# using with DataSync Discovery.
|
2309
|
+
#
|
2310
|
+
# @option params [required, String] :storage_system_arn
|
2311
|
+
# Specifies the Amazon Resource Name (ARN) of an on-premises storage
|
2312
|
+
# system that you're using with DataSync Discovery.
|
2313
|
+
#
|
2314
|
+
# @return [Types::DescribeStorageSystemResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2315
|
+
#
|
2316
|
+
# * {Types::DescribeStorageSystemResponse#storage_system_arn #storage_system_arn} => String
|
2317
|
+
# * {Types::DescribeStorageSystemResponse#server_configuration #server_configuration} => Types::DiscoveryServerConfiguration
|
2318
|
+
# * {Types::DescribeStorageSystemResponse#system_type #system_type} => String
|
2319
|
+
# * {Types::DescribeStorageSystemResponse#agent_arns #agent_arns} => Array<String>
|
2320
|
+
# * {Types::DescribeStorageSystemResponse#name #name} => String
|
2321
|
+
# * {Types::DescribeStorageSystemResponse#error_message #error_message} => String
|
2322
|
+
# * {Types::DescribeStorageSystemResponse#connectivity_status #connectivity_status} => String
|
2323
|
+
# * {Types::DescribeStorageSystemResponse#cloud_watch_log_group_arn #cloud_watch_log_group_arn} => String
|
2324
|
+
# * {Types::DescribeStorageSystemResponse#creation_time #creation_time} => Time
|
2325
|
+
# * {Types::DescribeStorageSystemResponse#secrets_manager_arn #secrets_manager_arn} => String
|
2326
|
+
#
|
2327
|
+
# @example Request syntax with placeholder values
|
2328
|
+
#
|
2329
|
+
# resp = client.describe_storage_system({
|
2330
|
+
# storage_system_arn: "StorageSystemArn", # required
|
2331
|
+
# })
|
2332
|
+
#
|
2333
|
+
# @example Response structure
|
2334
|
+
#
|
2335
|
+
# resp.storage_system_arn #=> String
|
2336
|
+
# resp.server_configuration.server_hostname #=> String
|
2337
|
+
# resp.server_configuration.server_port #=> Integer
|
2338
|
+
# resp.system_type #=> String, one of "NetAppONTAP"
|
2339
|
+
# resp.agent_arns #=> Array
|
2340
|
+
# resp.agent_arns[0] #=> String
|
2341
|
+
# resp.name #=> String
|
2342
|
+
# resp.error_message #=> String
|
2343
|
+
# resp.connectivity_status #=> String, one of "PASS", "FAIL", "UNKNOWN"
|
2344
|
+
# resp.cloud_watch_log_group_arn #=> String
|
2345
|
+
# resp.creation_time #=> Time
|
2346
|
+
# resp.secrets_manager_arn #=> String
|
2347
|
+
#
|
2348
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeStorageSystem AWS API Documentation
|
2349
|
+
#
|
2350
|
+
# @overload describe_storage_system(params = {})
|
2351
|
+
# @param [Hash] params ({})
|
2352
|
+
def describe_storage_system(params = {}, options = {})
|
2353
|
+
req = build_request(:describe_storage_system, params)
|
2354
|
+
req.send_request(options)
|
2355
|
+
end
|
2356
|
+
|
2357
|
+
# Returns information, including performance data and capacity usage,
|
2358
|
+
# which DataSync Discovery collects about a specific resource in
|
2359
|
+
# your-premises storage system.
|
2360
|
+
#
|
2361
|
+
# @option params [required, String] :discovery_job_arn
|
2362
|
+
# Specifies the Amazon Resource Name (ARN) of the discovery job that
|
2363
|
+
# collects information about your on-premises storage system.
|
2364
|
+
#
|
2365
|
+
# @option params [required, String] :resource_type
|
2366
|
+
# Specifies the kind of storage system resource that you want
|
2367
|
+
# information about.
|
2368
|
+
#
|
2369
|
+
# @option params [required, String] :resource_id
|
2370
|
+
# Specifies the universally unique identifier (UUID) of the storage
|
2371
|
+
# system resource that you want information about.
|
2372
|
+
#
|
2373
|
+
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
2374
|
+
# Specifies a time within the total duration that the discovery job ran.
|
2375
|
+
# To see information gathered during a certain time frame, use this
|
2376
|
+
# parameter with `EndTime`.
|
2377
|
+
#
|
2378
|
+
# @option params [Time,DateTime,Date,Integer,String] :end_time
|
2379
|
+
# Specifies a time within the total duration that the discovery job ran.
|
2380
|
+
# To see information gathered during a certain time frame, use this
|
2381
|
+
# parameter with `StartTime`.
|
2382
|
+
#
|
2383
|
+
# @option params [Integer] :max_results
|
2384
|
+
# Specifies how many results that you want in the response.
|
2385
|
+
#
|
2386
|
+
# @option params [String] :next_token
|
2387
|
+
# Specifies an opaque string that indicates the position to begin the
|
2388
|
+
# next list of results in the response.
|
2389
|
+
#
|
2390
|
+
# @return [Types::DescribeStorageSystemResourceMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2391
|
+
#
|
2392
|
+
# * {Types::DescribeStorageSystemResourceMetricsResponse#metrics #metrics} => Array<Types::ResourceMetrics>
|
2393
|
+
# * {Types::DescribeStorageSystemResourceMetricsResponse#next_token #next_token} => String
|
2394
|
+
#
|
2395
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2396
|
+
#
|
2397
|
+
# @example Request syntax with placeholder values
|
2398
|
+
#
|
2399
|
+
# resp = client.describe_storage_system_resource_metrics({
|
2400
|
+
# discovery_job_arn: "DiscoveryJobArn", # required
|
2401
|
+
# resource_type: "SVM", # required, accepts SVM, VOLUME, CLUSTER
|
2402
|
+
# resource_id: "ResourceId", # required
|
2403
|
+
# start_time: Time.now,
|
2404
|
+
# end_time: Time.now,
|
2405
|
+
# max_results: 1,
|
2406
|
+
# next_token: "DiscoveryNextToken",
|
2407
|
+
# })
|
2408
|
+
#
|
2409
|
+
# @example Response structure
|
2410
|
+
#
|
2411
|
+
# resp.metrics #=> Array
|
2412
|
+
# resp.metrics[0].timestamp #=> Time
|
2413
|
+
# resp.metrics[0].p95_metrics.iops.read #=> Float
|
2414
|
+
# resp.metrics[0].p95_metrics.iops.write #=> Float
|
2415
|
+
# resp.metrics[0].p95_metrics.iops.other #=> Float
|
2416
|
+
# resp.metrics[0].p95_metrics.iops.total #=> Float
|
2417
|
+
# resp.metrics[0].p95_metrics.throughput.read #=> Float
|
2418
|
+
# resp.metrics[0].p95_metrics.throughput.write #=> Float
|
2419
|
+
# resp.metrics[0].p95_metrics.throughput.other #=> Float
|
2420
|
+
# resp.metrics[0].p95_metrics.throughput.total #=> Float
|
2421
|
+
# resp.metrics[0].p95_metrics.latency.read #=> Float
|
2422
|
+
# resp.metrics[0].p95_metrics.latency.write #=> Float
|
2423
|
+
# resp.metrics[0].p95_metrics.latency.other #=> Float
|
2424
|
+
# resp.metrics[0].capacity.used #=> Integer
|
2425
|
+
# resp.metrics[0].capacity.provisioned #=> Integer
|
2426
|
+
# resp.metrics[0].capacity.logical_used #=> Integer
|
2427
|
+
# resp.metrics[0].resource_id #=> String
|
2428
|
+
# resp.metrics[0].resource_type #=> String, one of "SVM", "VOLUME", "CLUSTER"
|
2429
|
+
# resp.next_token #=> String
|
2430
|
+
#
|
2431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeStorageSystemResourceMetrics AWS API Documentation
|
2432
|
+
#
|
2433
|
+
# @overload describe_storage_system_resource_metrics(params = {})
|
2434
|
+
# @param [Hash] params ({})
|
2435
|
+
def describe_storage_system_resource_metrics(params = {}, options = {})
|
2436
|
+
req = build_request(:describe_storage_system_resource_metrics, params)
|
2437
|
+
req.send_request(options)
|
2438
|
+
end
|
2439
|
+
|
2440
|
+
# Returns information that DataSync Discovery collects about resources
|
2441
|
+
# in your on-premises storage system.
|
2442
|
+
#
|
2443
|
+
# @option params [required, String] :discovery_job_arn
|
2444
|
+
# Specifies the Amazon Resource Name (ARN) of the discovery job that's
|
2445
|
+
# collecting data from your on-premises storage system.
|
2446
|
+
#
|
2447
|
+
# @option params [required, String] :resource_type
|
2448
|
+
# Specifies what kind of storage system resources that you want
|
2449
|
+
# information about.
|
2450
|
+
#
|
2451
|
+
# @option params [Array<String>] :resource_ids
|
2452
|
+
# Specifies the universally unique identifiers (UUIDs) of the storage
|
2453
|
+
# system resources that you want information about. You can't use this
|
2454
|
+
# parameter in combination with the `Filter` parameter.
|
2455
|
+
#
|
2456
|
+
# @option params [Hash<String,Array>] :filter
|
2457
|
+
# Filters the storage system resources that you want returned. For
|
2458
|
+
# example, this might be volumes associated with a specific storage
|
2459
|
+
# virtual machine (SVM).
|
2460
|
+
#
|
2461
|
+
# @option params [Integer] :max_results
|
2462
|
+
# Specifies the maximum number of storage system resources that you want
|
2463
|
+
# to list in a response.
|
2464
|
+
#
|
2465
|
+
# @option params [String] :next_token
|
2466
|
+
# Specifies an opaque string that indicates the position to begin the
|
2467
|
+
# next list of results in the response.
|
2468
|
+
#
|
2469
|
+
# @return [Types::DescribeStorageSystemResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2470
|
+
#
|
2471
|
+
# * {Types::DescribeStorageSystemResourcesResponse#resource_details #resource_details} => Types::ResourceDetails
|
2472
|
+
# * {Types::DescribeStorageSystemResourcesResponse#next_token #next_token} => String
|
2473
|
+
#
|
2474
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2475
|
+
#
|
2476
|
+
# @example Request syntax with placeholder values
|
2477
|
+
#
|
2478
|
+
# resp = client.describe_storage_system_resources({
|
2479
|
+
# discovery_job_arn: "DiscoveryJobArn", # required
|
2480
|
+
# resource_type: "SVM", # required, accepts SVM, VOLUME, CLUSTER
|
2481
|
+
# resource_ids: ["ResourceId"],
|
2482
|
+
# filter: {
|
2483
|
+
# "SVM" => ["PtolemyString"],
|
2484
|
+
# },
|
2485
|
+
# max_results: 1,
|
2486
|
+
# next_token: "DiscoveryNextToken",
|
2487
|
+
# })
|
2488
|
+
#
|
2489
|
+
# @example Response structure
|
2490
|
+
#
|
2491
|
+
# resp.resource_details.net_app_ontapsv_ms #=> Array
|
2492
|
+
# resp.resource_details.net_app_ontapsv_ms[0].cluster_uuid #=> String
|
2493
|
+
# resp.resource_details.net_app_ontapsv_ms[0].resource_id #=> String
|
2494
|
+
# resp.resource_details.net_app_ontapsv_ms[0].svm_name #=> String
|
2495
|
+
# resp.resource_details.net_app_ontapsv_ms[0].cifs_share_count #=> Integer
|
2496
|
+
# resp.resource_details.net_app_ontapsv_ms[0].enabled_protocols #=> Array
|
2497
|
+
# resp.resource_details.net_app_ontapsv_ms[0].enabled_protocols[0] #=> String
|
2498
|
+
# resp.resource_details.net_app_ontapsv_ms[0].total_capacity_used #=> Integer
|
2499
|
+
# resp.resource_details.net_app_ontapsv_ms[0].total_capacity_provisioned #=> Integer
|
2500
|
+
# resp.resource_details.net_app_ontapsv_ms[0].total_logical_capacity_used #=> Integer
|
2501
|
+
# resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.iops_read #=> Float
|
2502
|
+
# resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.iops_write #=> Float
|
2503
|
+
# resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.iops_other #=> Float
|
2504
|
+
# resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.iops_total #=> Float
|
2505
|
+
# resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.throughput_read #=> Float
|
2506
|
+
# resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.throughput_write #=> Float
|
2507
|
+
# resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.throughput_other #=> Float
|
2508
|
+
# resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.throughput_total #=> Float
|
2509
|
+
# resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.latency_read #=> Float
|
2510
|
+
# resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.latency_write #=> Float
|
2511
|
+
# resp.resource_details.net_app_ontapsv_ms[0].max_p95_performance.latency_other #=> Float
|
2512
|
+
# resp.resource_details.net_app_ontapsv_ms[0].recommendations #=> Array
|
2513
|
+
# resp.resource_details.net_app_ontapsv_ms[0].recommendations[0].storage_type #=> String
|
2514
|
+
# resp.resource_details.net_app_ontapsv_ms[0].recommendations[0].storage_configuration #=> Hash
|
2515
|
+
# resp.resource_details.net_app_ontapsv_ms[0].recommendations[0].storage_configuration["PtolemyString"] #=> String
|
2516
|
+
# resp.resource_details.net_app_ontapsv_ms[0].recommendations[0].estimated_monthly_storage_cost #=> String
|
2517
|
+
# resp.resource_details.net_app_ontapsv_ms[0].nfs_exported_volumes #=> Integer
|
2518
|
+
# resp.resource_details.net_app_ontapsv_ms[0].recommendation_status #=> String, one of "NONE", "IN_PROGRESS", "COMPLETED", "FAILED"
|
2519
|
+
# resp.resource_details.net_app_ontapsv_ms[0].total_snapshot_capacity_used #=> Integer
|
2520
|
+
# resp.resource_details.net_app_ontap_volumes #=> Array
|
2521
|
+
# resp.resource_details.net_app_ontap_volumes[0].volume_name #=> String
|
2522
|
+
# resp.resource_details.net_app_ontap_volumes[0].resource_id #=> String
|
2523
|
+
# resp.resource_details.net_app_ontap_volumes[0].cifs_share_count #=> Integer
|
2524
|
+
# resp.resource_details.net_app_ontap_volumes[0].security_style #=> String
|
2525
|
+
# resp.resource_details.net_app_ontap_volumes[0].svm_uuid #=> String
|
2526
|
+
# resp.resource_details.net_app_ontap_volumes[0].svm_name #=> String
|
2527
|
+
# resp.resource_details.net_app_ontap_volumes[0].capacity_used #=> Integer
|
2528
|
+
# resp.resource_details.net_app_ontap_volumes[0].capacity_provisioned #=> Integer
|
2529
|
+
# resp.resource_details.net_app_ontap_volumes[0].logical_capacity_used #=> Integer
|
2530
|
+
# resp.resource_details.net_app_ontap_volumes[0].nfs_exported #=> Boolean
|
2531
|
+
# resp.resource_details.net_app_ontap_volumes[0].snapshot_capacity_used #=> Integer
|
2532
|
+
# resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.iops_read #=> Float
|
2533
|
+
# resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.iops_write #=> Float
|
2534
|
+
# resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.iops_other #=> Float
|
2535
|
+
# resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.iops_total #=> Float
|
2536
|
+
# resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.throughput_read #=> Float
|
2537
|
+
# resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.throughput_write #=> Float
|
2538
|
+
# resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.throughput_other #=> Float
|
2539
|
+
# resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.throughput_total #=> Float
|
2540
|
+
# resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.latency_read #=> Float
|
2541
|
+
# resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.latency_write #=> Float
|
2542
|
+
# resp.resource_details.net_app_ontap_volumes[0].max_p95_performance.latency_other #=> Float
|
2543
|
+
# resp.resource_details.net_app_ontap_volumes[0].recommendations #=> Array
|
2544
|
+
# resp.resource_details.net_app_ontap_volumes[0].recommendations[0].storage_type #=> String
|
2545
|
+
# resp.resource_details.net_app_ontap_volumes[0].recommendations[0].storage_configuration #=> Hash
|
2546
|
+
# resp.resource_details.net_app_ontap_volumes[0].recommendations[0].storage_configuration["PtolemyString"] #=> String
|
2547
|
+
# resp.resource_details.net_app_ontap_volumes[0].recommendations[0].estimated_monthly_storage_cost #=> String
|
2548
|
+
# resp.resource_details.net_app_ontap_volumes[0].recommendation_status #=> String, one of "NONE", "IN_PROGRESS", "COMPLETED", "FAILED"
|
2549
|
+
# resp.resource_details.net_app_ontap_clusters #=> Array
|
2550
|
+
# resp.resource_details.net_app_ontap_clusters[0].cifs_share_count #=> Integer
|
2551
|
+
# resp.resource_details.net_app_ontap_clusters[0].nfs_exported_volumes #=> Integer
|
2552
|
+
# resp.resource_details.net_app_ontap_clusters[0].resource_id #=> String
|
2553
|
+
# resp.resource_details.net_app_ontap_clusters[0].cluster_name #=> String
|
2554
|
+
# resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.iops_read #=> Float
|
2555
|
+
# resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.iops_write #=> Float
|
2556
|
+
# resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.iops_other #=> Float
|
2557
|
+
# resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.iops_total #=> Float
|
2558
|
+
# resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.throughput_read #=> Float
|
2559
|
+
# resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.throughput_write #=> Float
|
2560
|
+
# resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.throughput_other #=> Float
|
2561
|
+
# resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.throughput_total #=> Float
|
2562
|
+
# resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.latency_read #=> Float
|
2563
|
+
# resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.latency_write #=> Float
|
2564
|
+
# resp.resource_details.net_app_ontap_clusters[0].max_p95_performance.latency_other #=> Float
|
2565
|
+
# resp.resource_details.net_app_ontap_clusters[0].cluster_block_storage_size #=> Integer
|
2566
|
+
# resp.resource_details.net_app_ontap_clusters[0].cluster_block_storage_used #=> Integer
|
2567
|
+
# resp.resource_details.net_app_ontap_clusters[0].cluster_block_storage_logical_used #=> Integer
|
2568
|
+
# resp.resource_details.net_app_ontap_clusters[0].recommendations #=> Array
|
2569
|
+
# resp.resource_details.net_app_ontap_clusters[0].recommendations[0].storage_type #=> String
|
2570
|
+
# resp.resource_details.net_app_ontap_clusters[0].recommendations[0].storage_configuration #=> Hash
|
2571
|
+
# resp.resource_details.net_app_ontap_clusters[0].recommendations[0].storage_configuration["PtolemyString"] #=> String
|
2572
|
+
# resp.resource_details.net_app_ontap_clusters[0].recommendations[0].estimated_monthly_storage_cost #=> String
|
2573
|
+
# resp.resource_details.net_app_ontap_clusters[0].recommendation_status #=> String, one of "NONE", "IN_PROGRESS", "COMPLETED", "FAILED"
|
2574
|
+
# resp.next_token #=> String
|
2575
|
+
#
|
2576
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeStorageSystemResources AWS API Documentation
|
2577
|
+
#
|
2578
|
+
# @overload describe_storage_system_resources(params = {})
|
2579
|
+
# @param [Hash] params ({})
|
2580
|
+
def describe_storage_system_resources(params = {}, options = {})
|
2581
|
+
req = build_request(:describe_storage_system_resources, params)
|
2582
|
+
req.send_request(options)
|
2583
|
+
end
|
2584
|
+
|
2163
2585
|
# Returns metadata about a task.
|
2164
2586
|
#
|
2165
2587
|
# @option params [required, String] :task_arn
|
@@ -2316,6 +2738,58 @@ module Aws::DataSync
|
|
2316
2738
|
req.send_request(options)
|
2317
2739
|
end
|
2318
2740
|
|
2741
|
+
# Creates recommendations about where to migrate your data to in Amazon
|
2742
|
+
# Web Services. Recommendations are generated based on information that
|
2743
|
+
# DataSync Discovery collects about your on-premises storage system's
|
2744
|
+
# resources. For more information, see [Recommendations provided by
|
2745
|
+
# DataSync Discovery][1].
|
2746
|
+
#
|
2747
|
+
# Once generated, you can view your recommendations by using the
|
2748
|
+
# [DescribeStorageSystemResources][2] operation.
|
2749
|
+
#
|
2750
|
+
# <note markdown="1"> If your [discovery job completes successfully][3], you don't need to
|
2751
|
+
# use this operation. DataSync Discovery generates the recommendations
|
2752
|
+
# for you automatically.
|
2753
|
+
#
|
2754
|
+
# </note>
|
2755
|
+
#
|
2756
|
+
#
|
2757
|
+
#
|
2758
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html
|
2759
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeStorageSystemResources.html
|
2760
|
+
# [3]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table
|
2761
|
+
#
|
2762
|
+
# @option params [required, String] :discovery_job_arn
|
2763
|
+
# Specifies the Amazon Resource Name (ARN) of the discovery job that
|
2764
|
+
# collects information about your on-premises storage system.
|
2765
|
+
#
|
2766
|
+
# @option params [required, Array<String>] :resource_ids
|
2767
|
+
# Specifies the universally unique identifiers (UUIDs) of the resources
|
2768
|
+
# in your storage system that you want recommendations on.
|
2769
|
+
#
|
2770
|
+
# @option params [required, String] :resource_type
|
2771
|
+
# Specifies the type of resource in your storage system that you want
|
2772
|
+
# recommendations on.
|
2773
|
+
#
|
2774
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2775
|
+
#
|
2776
|
+
# @example Request syntax with placeholder values
|
2777
|
+
#
|
2778
|
+
# resp = client.generate_recommendations({
|
2779
|
+
# discovery_job_arn: "DiscoveryJobArn", # required
|
2780
|
+
# resource_ids: ["ResourceId"], # required
|
2781
|
+
# resource_type: "SVM", # required, accepts SVM, VOLUME, CLUSTER
|
2782
|
+
# })
|
2783
|
+
#
|
2784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/GenerateRecommendations AWS API Documentation
|
2785
|
+
#
|
2786
|
+
# @overload generate_recommendations(params = {})
|
2787
|
+
# @param [Hash] params ({})
|
2788
|
+
def generate_recommendations(params = {}, options = {})
|
2789
|
+
req = build_request(:generate_recommendations, params)
|
2790
|
+
req.send_request(options)
|
2791
|
+
end
|
2792
|
+
|
2319
2793
|
# Returns a list of DataSync agents that belong to an Amazon Web
|
2320
2794
|
# Services account in the Amazon Web Services Region specified in the
|
2321
2795
|
# request.
|
@@ -2377,6 +2851,53 @@ module Aws::DataSync
|
|
2377
2851
|
req.send_request(options)
|
2378
2852
|
end
|
2379
2853
|
|
2854
|
+
# Provides a list of the existing discovery jobs in the Amazon Web
|
2855
|
+
# Services Region and Amazon Web Services account where you're using
|
2856
|
+
# DataSync Discovery.
|
2857
|
+
#
|
2858
|
+
# @option params [String] :storage_system_arn
|
2859
|
+
# Specifies the Amazon Resource Name (ARN) of an on-premises storage
|
2860
|
+
# system. Use this parameter if you only want to list the discovery jobs
|
2861
|
+
# that are associated with a specific storage system.
|
2862
|
+
#
|
2863
|
+
# @option params [Integer] :max_results
|
2864
|
+
# Specifies how many results you want in the response.
|
2865
|
+
#
|
2866
|
+
# @option params [String] :next_token
|
2867
|
+
# Specifies an opaque string that indicates the position to begin the
|
2868
|
+
# next list of results in the response.
|
2869
|
+
#
|
2870
|
+
# @return [Types::ListDiscoveryJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2871
|
+
#
|
2872
|
+
# * {Types::ListDiscoveryJobsResponse#discovery_jobs #discovery_jobs} => Array<Types::DiscoveryJobListEntry>
|
2873
|
+
# * {Types::ListDiscoveryJobsResponse#next_token #next_token} => String
|
2874
|
+
#
|
2875
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2876
|
+
#
|
2877
|
+
# @example Request syntax with placeholder values
|
2878
|
+
#
|
2879
|
+
# resp = client.list_discovery_jobs({
|
2880
|
+
# storage_system_arn: "StorageSystemArn",
|
2881
|
+
# max_results: 1,
|
2882
|
+
# next_token: "DiscoveryNextToken",
|
2883
|
+
# })
|
2884
|
+
#
|
2885
|
+
# @example Response structure
|
2886
|
+
#
|
2887
|
+
# resp.discovery_jobs #=> Array
|
2888
|
+
# resp.discovery_jobs[0].discovery_job_arn #=> String
|
2889
|
+
# resp.discovery_jobs[0].status #=> String, one of "RUNNING", "WARNING", "TERMINATED", "FAILED", "STOPPED", "COMPLETED", "COMPLETED_WITH_ISSUES"
|
2890
|
+
# resp.next_token #=> String
|
2891
|
+
#
|
2892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListDiscoveryJobs AWS API Documentation
|
2893
|
+
#
|
2894
|
+
# @overload list_discovery_jobs(params = {})
|
2895
|
+
# @param [Hash] params ({})
|
2896
|
+
def list_discovery_jobs(params = {}, options = {})
|
2897
|
+
req = build_request(:list_discovery_jobs, params)
|
2898
|
+
req.send_request(options)
|
2899
|
+
end
|
2900
|
+
|
2380
2901
|
# Returns a list of source and destination locations.
|
2381
2902
|
#
|
2382
2903
|
# If you have more locations than are returned in a response (that is,
|
@@ -2434,6 +2955,46 @@ module Aws::DataSync
|
|
2434
2955
|
req.send_request(options)
|
2435
2956
|
end
|
2436
2957
|
|
2958
|
+
# Lists the on-premises storage systems that you're using with DataSync
|
2959
|
+
# Discovery.
|
2960
|
+
#
|
2961
|
+
# @option params [Integer] :max_results
|
2962
|
+
# Specifies how many results you want in the response.
|
2963
|
+
#
|
2964
|
+
# @option params [String] :next_token
|
2965
|
+
# Specifies an opaque string that indicates the position to begin the
|
2966
|
+
# next list of results in the response.
|
2967
|
+
#
|
2968
|
+
# @return [Types::ListStorageSystemsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2969
|
+
#
|
2970
|
+
# * {Types::ListStorageSystemsResponse#storage_systems #storage_systems} => Array<Types::StorageSystemListEntry>
|
2971
|
+
# * {Types::ListStorageSystemsResponse#next_token #next_token} => String
|
2972
|
+
#
|
2973
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2974
|
+
#
|
2975
|
+
# @example Request syntax with placeholder values
|
2976
|
+
#
|
2977
|
+
# resp = client.list_storage_systems({
|
2978
|
+
# max_results: 1,
|
2979
|
+
# next_token: "DiscoveryNextToken",
|
2980
|
+
# })
|
2981
|
+
#
|
2982
|
+
# @example Response structure
|
2983
|
+
#
|
2984
|
+
# resp.storage_systems #=> Array
|
2985
|
+
# resp.storage_systems[0].storage_system_arn #=> String
|
2986
|
+
# resp.storage_systems[0].name #=> String
|
2987
|
+
# resp.next_token #=> String
|
2988
|
+
#
|
2989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListStorageSystems AWS API Documentation
|
2990
|
+
#
|
2991
|
+
# @overload list_storage_systems(params = {})
|
2992
|
+
# @param [Hash] params ({})
|
2993
|
+
def list_storage_systems(params = {}, options = {})
|
2994
|
+
req = build_request(:list_storage_systems, params)
|
2995
|
+
req.send_request(options)
|
2996
|
+
end
|
2997
|
+
|
2437
2998
|
# Returns all the tags associated with an Amazon Web Services resource.
|
2438
2999
|
#
|
2439
3000
|
# @option params [required, String] :resource_arn
|
@@ -2575,15 +3136,111 @@ module Aws::DataSync
|
|
2575
3136
|
req.send_request(options)
|
2576
3137
|
end
|
2577
3138
|
|
3139
|
+
# Permanently removes a storage system resource from DataSync Discovery,
|
3140
|
+
# including the associated discovery jobs, collected data, and
|
3141
|
+
# recommendations.
|
3142
|
+
#
|
3143
|
+
# @option params [required, String] :storage_system_arn
|
3144
|
+
# Specifies the Amazon Resource Name (ARN) of the storage system that
|
3145
|
+
# you want to permanently remove from DataSync Discovery.
|
3146
|
+
#
|
3147
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3148
|
+
#
|
3149
|
+
# @example Request syntax with placeholder values
|
3150
|
+
#
|
3151
|
+
# resp = client.remove_storage_system({
|
3152
|
+
# storage_system_arn: "StorageSystemArn", # required
|
3153
|
+
# })
|
3154
|
+
#
|
3155
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/RemoveStorageSystem AWS API Documentation
|
3156
|
+
#
|
3157
|
+
# @overload remove_storage_system(params = {})
|
3158
|
+
# @param [Hash] params ({})
|
3159
|
+
def remove_storage_system(params = {}, options = {})
|
3160
|
+
req = build_request(:remove_storage_system, params)
|
3161
|
+
req.send_request(options)
|
3162
|
+
end
|
3163
|
+
|
3164
|
+
# Runs a DataSync discovery job on your on-premises storage system. If
|
3165
|
+
# you haven't added the storage system to DataSync Discovery yet, do
|
3166
|
+
# this first by using the [AddStorageSystem][1] operation.
|
3167
|
+
#
|
3168
|
+
#
|
3169
|
+
#
|
3170
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_AddStorageSystem.html
|
3171
|
+
#
|
3172
|
+
# @option params [required, String] :storage_system_arn
|
3173
|
+
# Specifies the Amazon Resource Name (ARN) of the on-premises storage
|
3174
|
+
# system that you want to run the discovery job on.
|
3175
|
+
#
|
3176
|
+
# @option params [required, Integer] :collection_duration_minutes
|
3177
|
+
# Specifies in minutes how long you want the discovery job to run.
|
3178
|
+
#
|
3179
|
+
# <note markdown="1"> For more accurate recommendations, we recommend a duration of at least
|
3180
|
+
# 14 days. Longer durations allow time to collect a sufficient number of
|
3181
|
+
# data points and provide a realistic representation of storage
|
3182
|
+
# performance and utilization.
|
3183
|
+
#
|
3184
|
+
# </note>
|
3185
|
+
#
|
3186
|
+
# @option params [required, String] :client_token
|
3187
|
+
# Specifies a client token to make sure requests with this API operation
|
3188
|
+
# are idempotent. If you don't specify a client token, DataSync
|
3189
|
+
# generates one for you automatically.
|
3190
|
+
#
|
3191
|
+
# **A suitable default value is auto-generated.** You should normally
|
3192
|
+
# not need to pass this option.**
|
3193
|
+
#
|
3194
|
+
# @option params [Array<Types::TagListEntry>] :tags
|
3195
|
+
# Specifies labels that help you categorize, filter, and search for your
|
3196
|
+
# Amazon Web Services resources.
|
3197
|
+
#
|
3198
|
+
# @return [Types::StartDiscoveryJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3199
|
+
#
|
3200
|
+
# * {Types::StartDiscoveryJobResponse#discovery_job_arn #discovery_job_arn} => String
|
3201
|
+
#
|
3202
|
+
# @example Request syntax with placeholder values
|
3203
|
+
#
|
3204
|
+
# resp = client.start_discovery_job({
|
3205
|
+
# storage_system_arn: "StorageSystemArn", # required
|
3206
|
+
# collection_duration_minutes: 1, # required
|
3207
|
+
# client_token: "PtolemyUUID", # required
|
3208
|
+
# tags: [
|
3209
|
+
# {
|
3210
|
+
# key: "TagKey", # required
|
3211
|
+
# value: "TagValue",
|
3212
|
+
# },
|
3213
|
+
# ],
|
3214
|
+
# })
|
3215
|
+
#
|
3216
|
+
# @example Response structure
|
3217
|
+
#
|
3218
|
+
# resp.discovery_job_arn #=> String
|
3219
|
+
#
|
3220
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartDiscoveryJob AWS API Documentation
|
3221
|
+
#
|
3222
|
+
# @overload start_discovery_job(params = {})
|
3223
|
+
# @param [Hash] params ({})
|
3224
|
+
def start_discovery_job(params = {}, options = {})
|
3225
|
+
req = build_request(:start_discovery_job, params)
|
3226
|
+
req.send_request(options)
|
3227
|
+
end
|
3228
|
+
|
2578
3229
|
# Starts an DataSync task. For each task, you can only run one task
|
2579
3230
|
# execution at a time.
|
2580
3231
|
#
|
2581
3232
|
# There are several phases to a task execution. For more information,
|
2582
3233
|
# see [Task execution statuses][1].
|
2583
3234
|
#
|
3235
|
+
# If you're planning to transfer data to or from an Amazon S3 location,
|
3236
|
+
# review [how DataSync can affect your S3 request charges][2] and the
|
3237
|
+
# [DataSync pricing page][3] before you begin.
|
3238
|
+
#
|
2584
3239
|
#
|
2585
3240
|
#
|
2586
3241
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses
|
3242
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests
|
3243
|
+
# [3]: http://aws.amazon.com/datasync/pricing/
|
2587
3244
|
#
|
2588
3245
|
# @option params [required, String] :task_arn
|
2589
3246
|
# Specifies the Amazon Resource Name (ARN) of the task that you want to
|
@@ -2676,6 +3333,39 @@ module Aws::DataSync
|
|
2676
3333
|
req.send_request(options)
|
2677
3334
|
end
|
2678
3335
|
|
3336
|
+
# Stops a running DataSync discovery job.
|
3337
|
+
#
|
3338
|
+
# You can stop a discovery job anytime. A job that's stopped before
|
3339
|
+
# it's scheduled to end likely will provide you some information about
|
3340
|
+
# your on-premises storage system resources. To get recommendations for
|
3341
|
+
# a stopped job, you must use the [GenerateRecommendations][1]
|
3342
|
+
# operation.
|
3343
|
+
#
|
3344
|
+
#
|
3345
|
+
#
|
3346
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_GenerateRecommendations.html
|
3347
|
+
#
|
3348
|
+
# @option params [required, String] :discovery_job_arn
|
3349
|
+
# Specifies the Amazon Resource Name (ARN) of the discovery job that you
|
3350
|
+
# want to stop.
|
3351
|
+
#
|
3352
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3353
|
+
#
|
3354
|
+
# @example Request syntax with placeholder values
|
3355
|
+
#
|
3356
|
+
# resp = client.stop_discovery_job({
|
3357
|
+
# discovery_job_arn: "DiscoveryJobArn", # required
|
3358
|
+
# })
|
3359
|
+
#
|
3360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StopDiscoveryJob AWS API Documentation
|
3361
|
+
#
|
3362
|
+
# @overload stop_discovery_job(params = {})
|
3363
|
+
# @param [Hash] params ({})
|
3364
|
+
def stop_discovery_job(params = {}, options = {})
|
3365
|
+
req = build_request(:stop_discovery_job, params)
|
3366
|
+
req.send_request(options)
|
3367
|
+
end
|
3368
|
+
|
2679
3369
|
# Applies a *tag* to an Amazon Web Services resource. Tags are key-value
|
2680
3370
|
# pairs that can help you manage, filter, and search for your resources.
|
2681
3371
|
#
|
@@ -2765,6 +3455,35 @@ module Aws::DataSync
|
|
2765
3455
|
req.send_request(options)
|
2766
3456
|
end
|
2767
3457
|
|
3458
|
+
# Edits a DataSync discovery job configuration.
|
3459
|
+
#
|
3460
|
+
# @option params [required, String] :discovery_job_arn
|
3461
|
+
# Specifies the Amazon Resource Name (ARN) of the discovery job that you
|
3462
|
+
# want to update.
|
3463
|
+
#
|
3464
|
+
# @option params [required, Integer] :collection_duration_minutes
|
3465
|
+
# Specifies in minutes how long that you want the discovery job to run.
|
3466
|
+
# (You can't set this parameter to less than the number of minutes that
|
3467
|
+
# the job has already run for.)
|
3468
|
+
#
|
3469
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3470
|
+
#
|
3471
|
+
# @example Request syntax with placeholder values
|
3472
|
+
#
|
3473
|
+
# resp = client.update_discovery_job({
|
3474
|
+
# discovery_job_arn: "DiscoveryJobArn", # required
|
3475
|
+
# collection_duration_minutes: 1, # required
|
3476
|
+
# })
|
3477
|
+
#
|
3478
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateDiscoveryJob AWS API Documentation
|
3479
|
+
#
|
3480
|
+
# @overload update_discovery_job(params = {})
|
3481
|
+
# @param [Hash] params ({})
|
3482
|
+
def update_discovery_job(params = {}, options = {})
|
3483
|
+
req = build_request(:update_discovery_job, params)
|
3484
|
+
req.send_request(options)
|
3485
|
+
end
|
3486
|
+
|
2768
3487
|
# Updates some parameters of a previously created location for a Hadoop
|
2769
3488
|
# Distributed File System cluster.
|
2770
3489
|
#
|
@@ -3091,6 +3810,60 @@ module Aws::DataSync
|
|
3091
3810
|
req.send_request(options)
|
3092
3811
|
end
|
3093
3812
|
|
3813
|
+
# Modifies some configurations of an on-premises storage system resource
|
3814
|
+
# that you're using with DataSync Discovery.
|
3815
|
+
#
|
3816
|
+
# @option params [required, String] :storage_system_arn
|
3817
|
+
# Specifies the ARN of the on-premises storage system that you want
|
3818
|
+
# reconfigure.
|
3819
|
+
#
|
3820
|
+
# @option params [Types::DiscoveryServerConfiguration] :server_configuration
|
3821
|
+
# Specifies the server name and network port required to connect with
|
3822
|
+
# your on-premises storage system's management interface.
|
3823
|
+
#
|
3824
|
+
# @option params [Array<String>] :agent_arns
|
3825
|
+
# Specifies the Amazon Resource Name (ARN) of the DataSync agent that
|
3826
|
+
# connects to and reads your on-premises storage system.
|
3827
|
+
#
|
3828
|
+
# @option params [String] :name
|
3829
|
+
# Specifies a familiar name for your on-premises storage system.
|
3830
|
+
#
|
3831
|
+
# @option params [String] :cloud_watch_log_group_arn
|
3832
|
+
# Specifies the ARN of the Amazon CloudWatch log group for monitoring
|
3833
|
+
# and logging discovery job events.
|
3834
|
+
#
|
3835
|
+
# @option params [Types::Credentials] :credentials
|
3836
|
+
# Specifies the user name and password for accessing your on-premises
|
3837
|
+
# storage system's management interface.
|
3838
|
+
#
|
3839
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3840
|
+
#
|
3841
|
+
# @example Request syntax with placeholder values
|
3842
|
+
#
|
3843
|
+
# resp = client.update_storage_system({
|
3844
|
+
# storage_system_arn: "StorageSystemArn", # required
|
3845
|
+
# server_configuration: {
|
3846
|
+
# server_hostname: "DiscoveryServerHostname", # required
|
3847
|
+
# server_port: 1,
|
3848
|
+
# },
|
3849
|
+
# agent_arns: ["AgentArn"],
|
3850
|
+
# name: "Name",
|
3851
|
+
# cloud_watch_log_group_arn: "LogGroupArn",
|
3852
|
+
# credentials: {
|
3853
|
+
# username: "PtolemyUsername", # required
|
3854
|
+
# password: "PtolemyPassword", # required
|
3855
|
+
# },
|
3856
|
+
# })
|
3857
|
+
#
|
3858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateStorageSystem AWS API Documentation
|
3859
|
+
#
|
3860
|
+
# @overload update_storage_system(params = {})
|
3861
|
+
# @param [Hash] params ({})
|
3862
|
+
def update_storage_system(params = {}, options = {})
|
3863
|
+
req = build_request(:update_storage_system, params)
|
3864
|
+
req.send_request(options)
|
3865
|
+
end
|
3866
|
+
|
3094
3867
|
# Updates the metadata associated with a task.
|
3095
3868
|
#
|
3096
3869
|
# @option params [required, String] :task_arn
|
@@ -3194,24 +3967,17 @@ module Aws::DataSync
|
|
3194
3967
|
req.send_request(options)
|
3195
3968
|
end
|
3196
3969
|
|
3197
|
-
#
|
3198
|
-
#
|
3199
|
-
# You can modify bandwidth throttling for a task execution that is
|
3200
|
-
# running or queued. For more information, see [Adjusting Bandwidth
|
3201
|
-
# Throttling for a Task Execution][1].
|
3970
|
+
# Modifies a running DataSync task.
|
3202
3971
|
#
|
3203
|
-
# <note markdown="1">
|
3204
|
-
# BytesPerSecond
|
3972
|
+
# <note markdown="1"> Currently, the only `Option` that you can modify with
|
3973
|
+
# `UpdateTaskExecution` is ` BytesPerSecond `, which throttles bandwidth
|
3974
|
+
# for a running or queued task.
|
3205
3975
|
#
|
3206
3976
|
# </note>
|
3207
3977
|
#
|
3208
|
-
#
|
3209
|
-
#
|
3210
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#adjust-bandwidth-throttling
|
3211
|
-
#
|
3212
3978
|
# @option params [required, String] :task_execution_arn
|
3213
|
-
#
|
3214
|
-
#
|
3979
|
+
# Specifies the Amazon Resource Name (ARN) of the task execution that
|
3980
|
+
# you're updating.
|
3215
3981
|
#
|
3216
3982
|
# @option params [required, Types::Options] :options
|
3217
3983
|
# Configures your DataSync task settings. These options include how
|
@@ -3269,7 +4035,7 @@ module Aws::DataSync
|
|
3269
4035
|
params: params,
|
3270
4036
|
config: config)
|
3271
4037
|
context[:gem_name] = 'aws-sdk-datasync'
|
3272
|
-
context[:gem_version] = '1.
|
4038
|
+
context[:gem_version] = '1.56.0'
|
3273
4039
|
Seahorse::Client::Request.new(handlers, context)
|
3274
4040
|
end
|
3275
4041
|
|