aws-sdk-datasync 1.63.0 → 1.65.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-datasync/client.rb +205 -103
- data/lib/aws-sdk-datasync/client_api.rb +50 -0
- data/lib/aws-sdk-datasync/types.rb +439 -153
- data/lib/aws-sdk-datasync.rb +1 -1
- metadata +2 -2
@@ -133,8 +133,8 @@ module Aws::DataSync
|
|
133
133
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-sas-tokens
|
134
134
|
#
|
135
135
|
# @!attribute [rw] token
|
136
|
-
# Specifies a SAS token that provides permissions
|
137
|
-
#
|
136
|
+
# Specifies a SAS token that provides permissions to access your Azure
|
137
|
+
# Blob Storage.
|
138
138
|
#
|
139
139
|
# The token is part of the SAS URI string that comes after the storage
|
140
140
|
# resource URI and a question mark. A token looks something like this:
|
@@ -184,12 +184,18 @@ module Aws::DataSync
|
|
184
184
|
# without accounting for compression or deduplication.
|
185
185
|
# @return [Integer]
|
186
186
|
#
|
187
|
+
# @!attribute [rw] cluster_cloud_storage_used
|
188
|
+
# The amount of space in the cluster that's in cloud storage (for
|
189
|
+
# example, if you're using data tiering).
|
190
|
+
# @return [Integer]
|
191
|
+
#
|
187
192
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Capacity AWS API Documentation
|
188
193
|
#
|
189
194
|
class Capacity < Struct.new(
|
190
195
|
:used,
|
191
196
|
:provisioned,
|
192
|
-
:logical_used
|
197
|
+
:logical_used,
|
198
|
+
:cluster_cloud_storage_used)
|
193
199
|
SENSITIVE = []
|
194
200
|
include Aws::Structure
|
195
201
|
end
|
@@ -837,66 +843,38 @@ module Aws::DataSync
|
|
837
843
|
# CreateLocationNfsRequest
|
838
844
|
#
|
839
845
|
# @!attribute [rw] subdirectory
|
840
|
-
# Specifies the
|
841
|
-
#
|
842
|
-
# by the NFS server, or a subdirectory of that path. The path should
|
843
|
-
# be such that it can be mounted by other NFS clients in your network.
|
844
|
-
#
|
845
|
-
# To see all the paths exported by your NFS server, run "`showmount
|
846
|
-
# -e nfs-server-name`" from an NFS client that has access to your
|
847
|
-
# server. You can specify any directory that appears in the results,
|
848
|
-
# and any subdirectory of that directory. Ensure that the NFS export
|
849
|
-
# is accessible without Kerberos authentication.
|
846
|
+
# Specifies the export path in your NFS file server that you want
|
847
|
+
# DataSync to mount.
|
850
848
|
#
|
851
|
-
#
|
852
|
-
#
|
853
|
-
#
|
854
|
-
# permissions for all of the files that you want DataSync allow read
|
855
|
-
# access for all users. Doing either enables the agent to read the
|
856
|
-
# files. For the agent to access directories, you must additionally
|
857
|
-
# enable all execute access.
|
849
|
+
# This path (or a subdirectory of the path) is where DataSync
|
850
|
+
# transfers data to or from. For information on configuring an export
|
851
|
+
# for DataSync, see [Accessing NFS file servers][1].
|
858
852
|
#
|
859
|
-
# If you are copying data to or from your Snowcone device, see [NFS
|
860
|
-
# Server on Snowcone][1] for more information.
|
861
853
|
#
|
862
854
|
#
|
863
|
-
#
|
864
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone
|
855
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs
|
865
856
|
# @return [String]
|
866
857
|
#
|
867
858
|
# @!attribute [rw] server_hostname
|
868
|
-
# Specifies the
|
869
|
-
#
|
870
|
-
# NFS server in a network.
|
871
|
-
#
|
872
|
-
# If you are copying data to or from your Snowcone device, see [NFS
|
873
|
-
# Server on Snowcone][1] for more information.
|
874
|
-
#
|
875
|
-
# <note markdown="1"> You must specify be an IP version 4 address or Domain Name System
|
876
|
-
# (DNS)-compliant name.
|
877
|
-
#
|
878
|
-
# </note>
|
879
|
-
#
|
880
|
-
#
|
881
|
-
#
|
882
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone
|
859
|
+
# Specifies the Domain Name System (DNS) name or IP version 4 address
|
860
|
+
# of the NFS file server that your DataSync agent connects to.
|
883
861
|
# @return [String]
|
884
862
|
#
|
885
863
|
# @!attribute [rw] on_prem_config
|
886
|
-
# Specifies the Amazon Resource
|
887
|
-
#
|
864
|
+
# Specifies the Amazon Resource Name (ARN) of the DataSync agent that
|
865
|
+
# want to connect to your NFS file server.
|
888
866
|
#
|
889
|
-
#
|
890
|
-
#
|
867
|
+
# You can specify more than one agent. For more information, see
|
868
|
+
# [Using multiple agents for transfers][1].
|
891
869
|
#
|
892
870
|
#
|
893
871
|
#
|
894
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/
|
872
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html
|
895
873
|
# @return [Types::OnPremConfig]
|
896
874
|
#
|
897
875
|
# @!attribute [rw] mount_options
|
898
|
-
# Specifies the
|
899
|
-
#
|
876
|
+
# Specifies the options that DataSync can use to mount your NFS file
|
877
|
+
# server.
|
900
878
|
# @return [Types::NfsMountOptions]
|
901
879
|
#
|
902
880
|
# @!attribute [rw] tags
|
@@ -1304,6 +1282,11 @@ module Aws::DataSync
|
|
1304
1282
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
1305
1283
|
# @return [Array<Types::FilterRule>]
|
1306
1284
|
#
|
1285
|
+
# @!attribute [rw] task_report_config
|
1286
|
+
# Specifies how you want to configure a task report, which provides
|
1287
|
+
# detailed information about for your DataSync transfer.
|
1288
|
+
# @return [Types::TaskReportConfig]
|
1289
|
+
#
|
1307
1290
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTaskRequest AWS API Documentation
|
1308
1291
|
#
|
1309
1292
|
class CreateTaskRequest < Struct.new(
|
@@ -1315,7 +1298,8 @@ module Aws::DataSync
|
|
1315
1298
|
:excludes,
|
1316
1299
|
:schedule,
|
1317
1300
|
:tags,
|
1318
|
-
:includes
|
1301
|
+
:includes,
|
1302
|
+
:task_report_config)
|
1319
1303
|
SENSITIVE = []
|
1320
1304
|
include Aws::Structure
|
1321
1305
|
end
|
@@ -1978,7 +1962,8 @@ module Aws::DataSync
|
|
1978
1962
|
# DescribeLocationNfsRequest
|
1979
1963
|
#
|
1980
1964
|
# @!attribute [rw] location_arn
|
1981
|
-
#
|
1965
|
+
# Specifies the Amazon Resource Name (ARN) of the NFS location that
|
1966
|
+
# you want information about.
|
1982
1967
|
# @return [String]
|
1983
1968
|
#
|
1984
1969
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationNfsRequest AWS API Documentation
|
@@ -1992,25 +1977,24 @@ module Aws::DataSync
|
|
1992
1977
|
# DescribeLocationNfsResponse
|
1993
1978
|
#
|
1994
1979
|
# @!attribute [rw] location_arn
|
1995
|
-
# The
|
1996
|
-
# described.
|
1980
|
+
# The ARN of the NFS location.
|
1997
1981
|
# @return [String]
|
1998
1982
|
#
|
1999
1983
|
# @!attribute [rw] location_uri
|
2000
|
-
# The URL of the
|
1984
|
+
# The URL of the NFS location.
|
2001
1985
|
# @return [String]
|
2002
1986
|
#
|
2003
1987
|
# @!attribute [rw] on_prem_config
|
2004
|
-
#
|
2005
|
-
#
|
1988
|
+
# The DataSync agents that are connecting to a Network File System
|
1989
|
+
# (NFS) location.
|
2006
1990
|
# @return [Types::OnPremConfig]
|
2007
1991
|
#
|
2008
1992
|
# @!attribute [rw] mount_options
|
2009
|
-
# The mount options that DataSync uses to mount your NFS
|
1993
|
+
# The mount options that DataSync uses to mount your NFS file server.
|
2010
1994
|
# @return [Types::NfsMountOptions]
|
2011
1995
|
#
|
2012
1996
|
# @!attribute [rw] creation_time
|
2013
|
-
# The time
|
1997
|
+
# The time when the NFS location was created.
|
2014
1998
|
# @return [Time]
|
2015
1999
|
#
|
2016
2000
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationNfsResponse AWS API Documentation
|
@@ -2468,8 +2452,8 @@ module Aws::DataSync
|
|
2468
2452
|
# DescribeTaskExecutionRequest
|
2469
2453
|
#
|
2470
2454
|
# @!attribute [rw] task_execution_arn
|
2471
|
-
# Specifies the Amazon Resource Name (ARN) of the
|
2472
|
-
#
|
2455
|
+
# Specifies the Amazon Resource Name (ARN) of the task execution that
|
2456
|
+
# you want information about.
|
2473
2457
|
# @return [String]
|
2474
2458
|
#
|
2475
2459
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskExecutionRequest AWS API Documentation
|
@@ -2483,9 +2467,9 @@ module Aws::DataSync
|
|
2483
2467
|
# DescribeTaskExecutionResponse
|
2484
2468
|
#
|
2485
2469
|
# @!attribute [rw] task_execution_arn
|
2486
|
-
# The
|
2487
|
-
#
|
2488
|
-
#
|
2470
|
+
# The ARN of the task execution that you wanted information about.
|
2471
|
+
# `TaskExecutionArn` is hierarchical and includes `TaskArn` for the
|
2472
|
+
# task that was executed.
|
2489
2473
|
#
|
2490
2474
|
# For example, a `TaskExecution` value with the ARN
|
2491
2475
|
# `arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b`
|
@@ -2495,20 +2479,17 @@ module Aws::DataSync
|
|
2495
2479
|
#
|
2496
2480
|
# @!attribute [rw] status
|
2497
2481
|
# The status of the task execution.
|
2498
|
-
#
|
2499
|
-
# For detailed information about task execution statuses, see
|
2500
|
-
# Understanding Task Statuses in the *DataSync User Guide.*
|
2501
2482
|
# @return [String]
|
2502
2483
|
#
|
2503
2484
|
# @!attribute [rw] options
|
2504
|
-
#
|
2505
|
-
# DataSync handles files, objects, and their associated
|
2506
|
-
# also can specify how
|
2507
|
-
# limits for your task, among other
|
2508
|
-
#
|
2509
|
-
#
|
2510
|
-
#
|
2511
|
-
# task.
|
2485
|
+
# Indicates how your transfer task is configured. These options
|
2486
|
+
# include how DataSync handles files, objects, and their associated
|
2487
|
+
# metadata during your transfer. You also can specify how to verify
|
2488
|
+
# data integrity, set bandwidth limits for your task, among other
|
2489
|
+
# options.
|
2490
|
+
#
|
2491
|
+
# Each option has a default value. Unless you need to, you don't have
|
2492
|
+
# to configure any of these options before starting your task.
|
2512
2493
|
# @return [Types::Options]
|
2513
2494
|
#
|
2514
2495
|
# @!attribute [rw] excludes
|
@@ -2532,41 +2513,39 @@ module Aws::DataSync
|
|
2532
2513
|
# @return [Array<Types::FilterRule>]
|
2533
2514
|
#
|
2534
2515
|
# @!attribute [rw] start_time
|
2535
|
-
# The time
|
2516
|
+
# The time when the task execution started.
|
2536
2517
|
# @return [Time]
|
2537
2518
|
#
|
2538
2519
|
# @!attribute [rw] estimated_files_to_transfer
|
2539
|
-
# The expected number of files
|
2540
|
-
# network. This value is calculated during the
|
2541
|
-
#
|
2542
|
-
#
|
2543
|
-
#
|
2544
|
-
#
|
2520
|
+
# The expected number of files, objects, and directories that DataSync
|
2521
|
+
# will transfer over the network. This value is calculated during the
|
2522
|
+
# task execution's `PREPARING` phase before the `TRANSFERRING` phase.
|
2523
|
+
# The calculation is based on comparing the content of the source and
|
2524
|
+
# destination locations and finding the difference that needs to be
|
2525
|
+
# transferred.
|
2545
2526
|
# @return [Integer]
|
2546
2527
|
#
|
2547
2528
|
# @!attribute [rw] estimated_bytes_to_transfer
|
2548
|
-
# The estimated physical number of bytes that
|
2549
|
-
#
|
2529
|
+
# The estimated physical number of bytes that will transfer over the
|
2530
|
+
# network.
|
2550
2531
|
# @return [Integer]
|
2551
2532
|
#
|
2552
2533
|
# @!attribute [rw] files_transferred
|
2553
|
-
# The actual number of files
|
2554
|
-
# This value is
|
2555
|
-
#
|
2556
|
-
#
|
2557
|
-
# the network.
|
2534
|
+
# The actual number of files, objects, and directories that DataSync
|
2535
|
+
# transferred over the network. This value is updated periodically
|
2536
|
+
# during the task execution's `TRANSFERRING` phase when something is
|
2537
|
+
# read from the source and sent over the network.
|
2558
2538
|
#
|
2559
|
-
# If
|
2539
|
+
# If DataSync fails to transfer something, this value can be less than
|
2560
2540
|
# `EstimatedFilesToTransfer`. In some cases, this value can also be
|
2561
2541
|
# greater than `EstimatedFilesToTransfer`. This element is
|
2562
2542
|
# implementation-specific for some location types, so don't use it as
|
2563
|
-
# an
|
2543
|
+
# an exact indication of what transferred or to monitor your task
|
2564
2544
|
# execution.
|
2565
2545
|
# @return [Integer]
|
2566
2546
|
#
|
2567
2547
|
# @!attribute [rw] bytes_written
|
2568
|
-
# The number of logical bytes written to the destination
|
2569
|
-
# Services storage resource.
|
2548
|
+
# The number of logical bytes written to the destination location.
|
2570
2549
|
# @return [Integer]
|
2571
2550
|
#
|
2572
2551
|
# @!attribute [rw] bytes_transferred
|
@@ -2584,6 +2563,52 @@ module Aws::DataSync
|
|
2584
2563
|
# `BytesTransferred` unless the data isn't compressible.
|
2585
2564
|
# @return [Integer]
|
2586
2565
|
#
|
2566
|
+
# @!attribute [rw] task_report_config
|
2567
|
+
# The configuration of your task report, which provides detailed
|
2568
|
+
# information about for your DataSync transfer.
|
2569
|
+
# @return [Types::TaskReportConfig]
|
2570
|
+
#
|
2571
|
+
# @!attribute [rw] files_deleted
|
2572
|
+
# The number of files, objects, and directories that DataSync deleted
|
2573
|
+
# in your destination location. If you don't [configure your task][1]
|
2574
|
+
# to delete data in the destination that isn't in the source, the
|
2575
|
+
# value is always `0`.
|
2576
|
+
#
|
2577
|
+
#
|
2578
|
+
#
|
2579
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html
|
2580
|
+
# @return [Integer]
|
2581
|
+
#
|
2582
|
+
# @!attribute [rw] files_skipped
|
2583
|
+
# The number of files, objects, and directories that DataSync skipped
|
2584
|
+
# during your transfer.
|
2585
|
+
# @return [Integer]
|
2586
|
+
#
|
2587
|
+
# @!attribute [rw] files_verified
|
2588
|
+
# The number of files, objects, and directories that DataSync verified
|
2589
|
+
# during your transfer.
|
2590
|
+
# @return [Integer]
|
2591
|
+
#
|
2592
|
+
# @!attribute [rw] report_result
|
2593
|
+
# Indicates whether DataSync generated a complete [task report][1] for
|
2594
|
+
# your transfer.
|
2595
|
+
#
|
2596
|
+
#
|
2597
|
+
#
|
2598
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
|
2599
|
+
# @return [Types::ReportResult]
|
2600
|
+
#
|
2601
|
+
# @!attribute [rw] estimated_files_to_delete
|
2602
|
+
# The expected number of files, objects, and directories that DataSync
|
2603
|
+
# will delete in your destination location. If you don't [configure
|
2604
|
+
# your task][1] to delete data in the destination that isn't in the
|
2605
|
+
# source, the value is always `0`.
|
2606
|
+
#
|
2607
|
+
#
|
2608
|
+
#
|
2609
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html
|
2610
|
+
# @return [Integer]
|
2611
|
+
#
|
2587
2612
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskExecutionResponse AWS API Documentation
|
2588
2613
|
#
|
2589
2614
|
class DescribeTaskExecutionResponse < Struct.new(
|
@@ -2599,7 +2624,13 @@ module Aws::DataSync
|
|
2599
2624
|
:bytes_written,
|
2600
2625
|
:bytes_transferred,
|
2601
2626
|
:result,
|
2602
|
-
:bytes_compressed
|
2627
|
+
:bytes_compressed,
|
2628
|
+
:task_report_config,
|
2629
|
+
:files_deleted,
|
2630
|
+
:files_skipped,
|
2631
|
+
:files_verified,
|
2632
|
+
:report_result,
|
2633
|
+
:estimated_files_to_delete)
|
2603
2634
|
SENSITIVE = []
|
2604
2635
|
include Aws::Structure
|
2605
2636
|
end
|
@@ -2731,6 +2762,15 @@ module Aws::DataSync
|
|
2731
2762
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
2732
2763
|
# @return [Array<Types::FilterRule>]
|
2733
2764
|
#
|
2765
|
+
# @!attribute [rw] task_report_config
|
2766
|
+
# The configuration of your task report. For more information, see
|
2767
|
+
# [Creating a task report][1].
|
2768
|
+
#
|
2769
|
+
#
|
2770
|
+
#
|
2771
|
+
# [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
|
2772
|
+
# @return [Types::TaskReportConfig]
|
2773
|
+
#
|
2734
2774
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskResponse AWS API Documentation
|
2735
2775
|
#
|
2736
2776
|
class DescribeTaskResponse < Struct.new(
|
@@ -2749,7 +2789,8 @@ module Aws::DataSync
|
|
2749
2789
|
:error_code,
|
2750
2790
|
:error_detail,
|
2751
2791
|
:creation_time,
|
2752
|
-
:includes
|
2792
|
+
:includes,
|
2793
|
+
:task_report_config)
|
2753
2794
|
SENSITIVE = []
|
2754
2795
|
include Aws::Structure
|
2755
2796
|
end
|
@@ -3645,6 +3686,11 @@ module Aws::DataSync
|
|
3645
3686
|
# The number of LUNs (logical unit numbers) in the cluster.
|
3646
3687
|
# @return [Integer]
|
3647
3688
|
#
|
3689
|
+
# @!attribute [rw] cluster_cloud_storage_used
|
3690
|
+
# The amount of space in the cluster that's in cloud storage (for
|
3691
|
+
# example, if you're using data tiering).
|
3692
|
+
# @return [Integer]
|
3693
|
+
#
|
3648
3694
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/NetAppONTAPCluster AWS API Documentation
|
3649
3695
|
#
|
3650
3696
|
class NetAppONTAPCluster < Struct.new(
|
@@ -3658,7 +3704,8 @@ module Aws::DataSync
|
|
3658
3704
|
:cluster_block_storage_logical_used,
|
3659
3705
|
:recommendations,
|
3660
3706
|
:recommendation_status,
|
3661
|
-
:lun_count
|
3707
|
+
:lun_count,
|
3708
|
+
:cluster_cloud_storage_used)
|
3662
3709
|
SENSITIVE = []
|
3663
3710
|
include Aws::Structure
|
3664
3711
|
end
|
@@ -3895,11 +3942,12 @@ module Aws::DataSync
|
|
3895
3942
|
include Aws::Structure
|
3896
3943
|
end
|
3897
3944
|
|
3898
|
-
#
|
3899
|
-
#
|
3945
|
+
# The DataSync agents that are connecting to a Network File System (NFS)
|
3946
|
+
# location.
|
3900
3947
|
#
|
3901
3948
|
# @!attribute [rw] agent_arns
|
3902
|
-
# ARNs of the agents to
|
3949
|
+
# The Amazon Resource Names (ARNs) of the agents connecting to a
|
3950
|
+
# transfer location.
|
3903
3951
|
# @return [Array<String>]
|
3904
3952
|
#
|
3905
3953
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/OnPremConfig AWS API Documentation
|
@@ -3910,13 +3958,13 @@ module Aws::DataSync
|
|
3910
3958
|
include Aws::Structure
|
3911
3959
|
end
|
3912
3960
|
|
3913
|
-
#
|
3914
|
-
# DataSync handles files, objects, and their associated metadata
|
3915
|
-
# also can specify how
|
3916
|
-
# limits for your task, among other options.
|
3961
|
+
# Indicates how your transfer task is configured. These options include
|
3962
|
+
# how DataSync handles files, objects, and their associated metadata
|
3963
|
+
# during your transfer. You also can specify how to verify data
|
3964
|
+
# integrity, set bandwidth limits for your task, among other options.
|
3917
3965
|
#
|
3918
|
-
# Each
|
3919
|
-
#
|
3966
|
+
# Each option has a default value. Unless you need to, you don't have
|
3967
|
+
# to configure any of these options before starting your task.
|
3920
3968
|
#
|
3921
3969
|
# @!attribute [rw] verify_mode
|
3922
3970
|
# Specifies how and when DataSync checks the integrity of your data
|
@@ -4392,6 +4440,175 @@ module Aws::DataSync
|
|
4392
4440
|
#
|
4393
4441
|
class RemoveStorageSystemResponse < Aws::EmptyStructure; end
|
4394
4442
|
|
4443
|
+
# Specifies where DataSync uploads your [task report][1].
|
4444
|
+
#
|
4445
|
+
#
|
4446
|
+
#
|
4447
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
|
4448
|
+
#
|
4449
|
+
# @!attribute [rw] s3
|
4450
|
+
# Specifies the Amazon S3 bucket where DataSync uploads your task
|
4451
|
+
# report.
|
4452
|
+
# @return [Types::ReportDestinationS3]
|
4453
|
+
#
|
4454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ReportDestination AWS API Documentation
|
4455
|
+
#
|
4456
|
+
class ReportDestination < Struct.new(
|
4457
|
+
:s3)
|
4458
|
+
SENSITIVE = []
|
4459
|
+
include Aws::Structure
|
4460
|
+
end
|
4461
|
+
|
4462
|
+
# Specifies the Amazon S3 bucket where DataSync uploads your [task
|
4463
|
+
# report][1].
|
4464
|
+
#
|
4465
|
+
#
|
4466
|
+
#
|
4467
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
|
4468
|
+
#
|
4469
|
+
# @!attribute [rw] subdirectory
|
4470
|
+
# Specifies a bucket prefix for your report.
|
4471
|
+
# @return [String]
|
4472
|
+
#
|
4473
|
+
# @!attribute [rw] s3_bucket_arn
|
4474
|
+
# Specifies the ARN of the S3 bucket where DataSync uploads your
|
4475
|
+
# report.
|
4476
|
+
# @return [String]
|
4477
|
+
#
|
4478
|
+
# @!attribute [rw] bucket_access_role_arn
|
4479
|
+
# Specifies the Amazon Resource Name (ARN) of the IAM policy that
|
4480
|
+
# allows DataSync to upload a task report to your S3 bucket. For more
|
4481
|
+
# information, see [Allowing DataSync to upload a task report to an
|
4482
|
+
# Amazon S3 bucket][1].
|
4483
|
+
#
|
4484
|
+
#
|
4485
|
+
#
|
4486
|
+
# [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
|
4487
|
+
# @return [String]
|
4488
|
+
#
|
4489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ReportDestinationS3 AWS API Documentation
|
4490
|
+
#
|
4491
|
+
class ReportDestinationS3 < Struct.new(
|
4492
|
+
:subdirectory,
|
4493
|
+
:s3_bucket_arn,
|
4494
|
+
:bucket_access_role_arn)
|
4495
|
+
SENSITIVE = []
|
4496
|
+
include Aws::Structure
|
4497
|
+
end
|
4498
|
+
|
4499
|
+
# Specifies the level of detail for a particular aspect of your DataSync
|
4500
|
+
# [task report][1].
|
4501
|
+
#
|
4502
|
+
#
|
4503
|
+
#
|
4504
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
|
4505
|
+
#
|
4506
|
+
# @!attribute [rw] report_level
|
4507
|
+
# Specifies whether your task report includes errors only or successes
|
4508
|
+
# and errors.
|
4509
|
+
#
|
4510
|
+
# For example, your report might mostly include only what didn't go
|
4511
|
+
# well in your transfer (`ERRORS_ONLY`). At the same time, you want to
|
4512
|
+
# verify that your [task filter][1] is working correctly. In this
|
4513
|
+
# situation, you can get a list of what files DataSync successfully
|
4514
|
+
# skipped and if something transferred that you didn't to transfer
|
4515
|
+
# (`SUCCESSES_AND_ERRORS`).
|
4516
|
+
#
|
4517
|
+
#
|
4518
|
+
#
|
4519
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
4520
|
+
# @return [String]
|
4521
|
+
#
|
4522
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ReportOverride AWS API Documentation
|
4523
|
+
#
|
4524
|
+
class ReportOverride < Struct.new(
|
4525
|
+
:report_level)
|
4526
|
+
SENSITIVE = []
|
4527
|
+
include Aws::Structure
|
4528
|
+
end
|
4529
|
+
|
4530
|
+
# The level of detail included in each aspect of your DataSync [task
|
4531
|
+
# report][1].
|
4532
|
+
#
|
4533
|
+
#
|
4534
|
+
#
|
4535
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
|
4536
|
+
#
|
4537
|
+
# @!attribute [rw] transferred
|
4538
|
+
# Specifies the level of reporting for the files, objects, and
|
4539
|
+
# directories that DataSync attempted to transfer.
|
4540
|
+
# @return [Types::ReportOverride]
|
4541
|
+
#
|
4542
|
+
# @!attribute [rw] verified
|
4543
|
+
# Specifies the level of reporting for the files, objects, and
|
4544
|
+
# directories that DataSync attempted to verify at the end of your
|
4545
|
+
# transfer. This only applies if you [configure your task][1] to
|
4546
|
+
# verify data during and after the transfer (which DataSync does by
|
4547
|
+
# default).
|
4548
|
+
#
|
4549
|
+
#
|
4550
|
+
#
|
4551
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-data-verification-options.html
|
4552
|
+
# @return [Types::ReportOverride]
|
4553
|
+
#
|
4554
|
+
# @!attribute [rw] deleted
|
4555
|
+
# Specifies the level of reporting for the files, objects, and
|
4556
|
+
# directories that DataSync attempted to delete in your destination
|
4557
|
+
# location. This only applies if you [configure your task][1] to
|
4558
|
+
# delete data in the destination that isn't in the source.
|
4559
|
+
#
|
4560
|
+
#
|
4561
|
+
#
|
4562
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html
|
4563
|
+
# @return [Types::ReportOverride]
|
4564
|
+
#
|
4565
|
+
# @!attribute [rw] skipped
|
4566
|
+
# Specifies the level of reporting for the files, objects, and
|
4567
|
+
# directories that DataSync attempted to skip during your transfer.
|
4568
|
+
# @return [Types::ReportOverride]
|
4569
|
+
#
|
4570
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ReportOverrides AWS API Documentation
|
4571
|
+
#
|
4572
|
+
class ReportOverrides < Struct.new(
|
4573
|
+
:transferred,
|
4574
|
+
:verified,
|
4575
|
+
:deleted,
|
4576
|
+
:skipped)
|
4577
|
+
SENSITIVE = []
|
4578
|
+
include Aws::Structure
|
4579
|
+
end
|
4580
|
+
|
4581
|
+
# Indicates whether DataSync created a complete [task report][1] for
|
4582
|
+
# your transfer.
|
4583
|
+
#
|
4584
|
+
#
|
4585
|
+
#
|
4586
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
|
4587
|
+
#
|
4588
|
+
# @!attribute [rw] status
|
4589
|
+
# Indicates whether DataSync is still working on your report, created
|
4590
|
+
# a report, or can't create a complete report.
|
4591
|
+
# @return [String]
|
4592
|
+
#
|
4593
|
+
# @!attribute [rw] error_code
|
4594
|
+
# Indicates the code associated with the error if DataSync can't
|
4595
|
+
# create a complete report.
|
4596
|
+
# @return [String]
|
4597
|
+
#
|
4598
|
+
# @!attribute [rw] error_detail
|
4599
|
+
# Provides details about issues creating a report.
|
4600
|
+
# @return [String]
|
4601
|
+
#
|
4602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ReportResult AWS API Documentation
|
4603
|
+
#
|
4604
|
+
class ReportResult < Struct.new(
|
4605
|
+
:status,
|
4606
|
+
:error_code,
|
4607
|
+
:error_detail)
|
4608
|
+
SENSITIVE = []
|
4609
|
+
include Aws::Structure
|
4610
|
+
end
|
4611
|
+
|
4395
4612
|
# Information provided by DataSync Discovery about the resources in your
|
4396
4613
|
# on-premises storage system.
|
4397
4614
|
#
|
@@ -4588,14 +4805,14 @@ module Aws::DataSync
|
|
4588
4805
|
# @return [String]
|
4589
4806
|
#
|
4590
4807
|
# @!attribute [rw] override_options
|
4591
|
-
#
|
4592
|
-
# DataSync handles files, objects, and their associated
|
4593
|
-
# also can specify how
|
4594
|
-
# limits for your task, among other
|
4595
|
-
#
|
4596
|
-
#
|
4597
|
-
#
|
4598
|
-
# task.
|
4808
|
+
# Indicates how your transfer task is configured. These options
|
4809
|
+
# include how DataSync handles files, objects, and their associated
|
4810
|
+
# metadata during your transfer. You also can specify how to verify
|
4811
|
+
# data integrity, set bandwidth limits for your task, among other
|
4812
|
+
# options.
|
4813
|
+
#
|
4814
|
+
# Each option has a default value. Unless you need to, you don't have
|
4815
|
+
# to configure any of these options before starting your task.
|
4599
4816
|
# @return [Types::Options]
|
4600
4817
|
#
|
4601
4818
|
# @!attribute [rw] includes
|
@@ -4621,6 +4838,11 @@ module Aws::DataSync
|
|
4621
4838
|
# for your DataSync resources.
|
4622
4839
|
# @return [Array<Types::TagListEntry>]
|
4623
4840
|
#
|
4841
|
+
# @!attribute [rw] task_report_config
|
4842
|
+
# Specifies how you want to configure a task report, which provides
|
4843
|
+
# detailed information about for your DataSync transfer.
|
4844
|
+
# @return [Types::TaskReportConfig]
|
4845
|
+
#
|
4624
4846
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartTaskExecutionRequest AWS API Documentation
|
4625
4847
|
#
|
4626
4848
|
class StartTaskExecutionRequest < Struct.new(
|
@@ -4628,7 +4850,8 @@ module Aws::DataSync
|
|
4628
4850
|
:override_options,
|
4629
4851
|
:includes,
|
4630
4852
|
:excludes,
|
4631
|
-
:tags
|
4853
|
+
:tags,
|
4854
|
+
:task_report_config)
|
4632
4855
|
SENSITIVE = []
|
4633
4856
|
include Aws::Structure
|
4634
4857
|
end
|
@@ -4887,6 +5110,79 @@ module Aws::DataSync
|
|
4887
5110
|
include Aws::Structure
|
4888
5111
|
end
|
4889
5112
|
|
5113
|
+
# Specifies how you want to configure a task report, which provides
|
5114
|
+
# detailed information about for your DataSync transfer.
|
5115
|
+
#
|
5116
|
+
# For more information, see [Task reports][1].
|
5117
|
+
#
|
5118
|
+
#
|
5119
|
+
#
|
5120
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
|
5121
|
+
#
|
5122
|
+
# @!attribute [rw] destination
|
5123
|
+
# Specifies the Amazon S3 bucket where DataSync uploads your task
|
5124
|
+
# report. For more information, see [Task reports][1].
|
5125
|
+
#
|
5126
|
+
#
|
5127
|
+
#
|
5128
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html#task-report-access
|
5129
|
+
# @return [Types::ReportDestination]
|
5130
|
+
#
|
5131
|
+
# @!attribute [rw] output_type
|
5132
|
+
# Specifies the type of task report that you want:
|
5133
|
+
#
|
5134
|
+
# * `SUMMARY_ONLY`: Provides necessary details about your task,
|
5135
|
+
# including the number of files, objects, and directories
|
5136
|
+
# transferred and transfer duration.
|
5137
|
+
#
|
5138
|
+
# * `STANDARD`: Provides complete details about your task, including a
|
5139
|
+
# full list of files, objects, and directories that were
|
5140
|
+
# transferred, skipped, verified, and more.
|
5141
|
+
# @return [String]
|
5142
|
+
#
|
5143
|
+
# @!attribute [rw] report_level
|
5144
|
+
# Specifies whether you want your task report to include only what
|
5145
|
+
# went wrong with your transfer or a list of what succeeded and
|
5146
|
+
# didn't.
|
5147
|
+
#
|
5148
|
+
# * `ERRORS_ONLY`: A report shows what DataSync was unable to
|
5149
|
+
# transfer, skip, verify, and delete.
|
5150
|
+
#
|
5151
|
+
# * `SUCCESSES_AND_ERRORS`: A report shows what DataSync was able and
|
5152
|
+
# unable to transfer, skip, verify, and delete.
|
5153
|
+
# @return [String]
|
5154
|
+
#
|
5155
|
+
# @!attribute [rw] object_version_ids
|
5156
|
+
# Specifies whether your task report includes the new version of each
|
5157
|
+
# object transferred into an S3 bucket. This only applies if you
|
5158
|
+
# [enable versioning on your bucket][1]. Keep in mind that setting
|
5159
|
+
# this to `INCLUDE` can increase the duration of your task execution.
|
5160
|
+
#
|
5161
|
+
#
|
5162
|
+
#
|
5163
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html
|
5164
|
+
# @return [String]
|
5165
|
+
#
|
5166
|
+
# @!attribute [rw] overrides
|
5167
|
+
# Customizes the reporting level for aspects of your task report. For
|
5168
|
+
# example, your report might generally only include errors, but you
|
5169
|
+
# could specify that you want a list of successes and errors just for
|
5170
|
+
# the files that DataSync attempted to delete in your destination
|
5171
|
+
# location.
|
5172
|
+
# @return [Types::ReportOverrides]
|
5173
|
+
#
|
5174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskReportConfig AWS API Documentation
|
5175
|
+
#
|
5176
|
+
class TaskReportConfig < Struct.new(
|
5177
|
+
:destination,
|
5178
|
+
:output_type,
|
5179
|
+
:report_level,
|
5180
|
+
:object_version_ids,
|
5181
|
+
:overrides)
|
5182
|
+
SENSITIVE = []
|
5183
|
+
include Aws::Structure
|
5184
|
+
end
|
5185
|
+
|
4890
5186
|
# Specifies the schedule you want your task to use for repeated
|
4891
5187
|
# executions. For more information, see [Schedule Expressions for
|
4892
5188
|
# Rules][1].
|
@@ -5177,42 +5473,26 @@ module Aws::DataSync
|
|
5177
5473
|
class UpdateLocationHdfsResponse < Aws::EmptyStructure; end
|
5178
5474
|
|
5179
5475
|
# @!attribute [rw] location_arn
|
5180
|
-
# Specifies the Amazon Resource Name (ARN) of the NFS
|
5181
|
-
# you want to update.
|
5476
|
+
# Specifies the Amazon Resource Name (ARN) of the NFS transfer
|
5477
|
+
# location that you want to update.
|
5182
5478
|
# @return [String]
|
5183
5479
|
#
|
5184
5480
|
# @!attribute [rw] subdirectory
|
5185
|
-
# Specifies the
|
5186
|
-
#
|
5187
|
-
# be exported by the NFS server, or a subdirectory of that path. The
|
5188
|
-
# path should be such that it can be mounted by other NFS clients in
|
5189
|
-
# your network.
|
5190
|
-
#
|
5191
|
-
# To see all the paths exported by your NFS server, run "`showmount
|
5192
|
-
# -e nfs-server-name`" from an NFS client that has access to your
|
5193
|
-
# server. You can specify any directory that appears in the results,
|
5194
|
-
# and any subdirectory of that directory. Ensure that the NFS export
|
5195
|
-
# is accessible without Kerberos authentication.
|
5196
|
-
#
|
5197
|
-
# To transfer all the data in the folder that you specified, DataSync
|
5198
|
-
# must have permissions to read all the data. To ensure this, either
|
5199
|
-
# configure the NFS export with `no_root_squash`, or ensure that the
|
5200
|
-
# files you want DataSync to access have permissions that allow read
|
5201
|
-
# access for all users. Doing either option enables the agent to read
|
5202
|
-
# the files. For the agent to access directories, you must
|
5203
|
-
# additionally enable all execute access.
|
5481
|
+
# Specifies the export path in your NFS file server that you want
|
5482
|
+
# DataSync to mount.
|
5204
5483
|
#
|
5205
|
-
#
|
5206
|
-
#
|
5484
|
+
# This path (or a subdirectory of the path) is where DataSync
|
5485
|
+
# transfers data to or from. For information on configuring an export
|
5486
|
+
# for DataSync, see [Accessing NFS file servers][1].
|
5207
5487
|
#
|
5208
5488
|
#
|
5209
5489
|
#
|
5210
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs
|
5490
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs
|
5211
5491
|
# @return [String]
|
5212
5492
|
#
|
5213
5493
|
# @!attribute [rw] on_prem_config
|
5214
|
-
#
|
5215
|
-
#
|
5494
|
+
# The DataSync agents that are connecting to a Network File System
|
5495
|
+
# (NFS) location.
|
5216
5496
|
# @return [Types::OnPremConfig]
|
5217
5497
|
#
|
5218
5498
|
# @!attribute [rw] mount_options
|
@@ -5430,14 +5710,14 @@ module Aws::DataSync
|
|
5430
5710
|
# @return [String]
|
5431
5711
|
#
|
5432
5712
|
# @!attribute [rw] options
|
5433
|
-
#
|
5434
|
-
# DataSync handles files, objects, and their associated
|
5435
|
-
# also can specify how
|
5436
|
-
# limits for your task, among other
|
5437
|
-
#
|
5438
|
-
#
|
5439
|
-
#
|
5440
|
-
# task.
|
5713
|
+
# Indicates how your transfer task is configured. These options
|
5714
|
+
# include how DataSync handles files, objects, and their associated
|
5715
|
+
# metadata during your transfer. You also can specify how to verify
|
5716
|
+
# data integrity, set bandwidth limits for your task, among other
|
5717
|
+
# options.
|
5718
|
+
#
|
5719
|
+
# Each option has a default value. Unless you need to, you don't have
|
5720
|
+
# to configure any of these options before starting your task.
|
5441
5721
|
# @return [Types::Options]
|
5442
5722
|
#
|
5443
5723
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecutionRequest AWS API Documentation
|
@@ -5461,14 +5741,14 @@ module Aws::DataSync
|
|
5461
5741
|
# @return [String]
|
5462
5742
|
#
|
5463
5743
|
# @!attribute [rw] options
|
5464
|
-
#
|
5465
|
-
# DataSync handles files, objects, and their associated
|
5466
|
-
# also can specify how
|
5467
|
-
# limits for your task, among other
|
5468
|
-
#
|
5469
|
-
#
|
5470
|
-
#
|
5471
|
-
# task.
|
5744
|
+
# Indicates how your transfer task is configured. These options
|
5745
|
+
# include how DataSync handles files, objects, and their associated
|
5746
|
+
# metadata during your transfer. You also can specify how to verify
|
5747
|
+
# data integrity, set bandwidth limits for your task, among other
|
5748
|
+
# options.
|
5749
|
+
#
|
5750
|
+
# Each option has a default value. Unless you need to, you don't have
|
5751
|
+
# to configure any of these options before starting your task.
|
5472
5752
|
# @return [Types::Options]
|
5473
5753
|
#
|
5474
5754
|
# @!attribute [rw] excludes
|
@@ -5513,6 +5793,11 @@ module Aws::DataSync
|
|
5513
5793
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
5514
5794
|
# @return [Array<Types::FilterRule>]
|
5515
5795
|
#
|
5796
|
+
# @!attribute [rw] task_report_config
|
5797
|
+
# Specifies how you want to configure a task report, which provides
|
5798
|
+
# detailed information about for your DataSync transfer.
|
5799
|
+
# @return [Types::TaskReportConfig]
|
5800
|
+
#
|
5516
5801
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskRequest AWS API Documentation
|
5517
5802
|
#
|
5518
5803
|
class UpdateTaskRequest < Struct.new(
|
@@ -5522,7 +5807,8 @@ module Aws::DataSync
|
|
5522
5807
|
:schedule,
|
5523
5808
|
:name,
|
5524
5809
|
:cloud_watch_log_group_arn,
|
5525
|
-
:includes
|
5810
|
+
:includes,
|
5811
|
+
:task_report_config)
|
5526
5812
|
SENSITIVE = []
|
5527
5813
|
include Aws::Structure
|
5528
5814
|
end
|