aws-sdk-datasync 1.64.0 → 1.66.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 +158 -39
- data/lib/aws-sdk-datasync/client_api.rb +48 -0
- data/lib/aws-sdk-datasync/types.rb +382 -71
- data/lib/aws-sdk-datasync.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 500986650a17cee914cf461d341c601891ffe719060e282729af743176f6618a
|
4
|
+
data.tar.gz: 99226e389e7422135db7159506f9f0fb93c623ede75cf04fe34e112495966944
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 45c4b3b5ab172d62013b3a7a753bd2bc6ba1df49ebbb49f0f55656ffa1d3fd9af172cd6a75294bae188bded7049b903e896dcf97541739d4a54fd1da7c5ca702
|
7
|
+
data.tar.gz: 825ed2e9fe2a63b7ba0d238cbdda2ba80ceec16937a6595211ca581319fc7225aefe74c2041b97380984e99f5fdfb3f13c84e2d7626b3727dacf167c86a64268
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.66.0 (2023-09-15)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Documentation-only updates for AWS DataSync.
|
8
|
+
|
9
|
+
1.65.0 (2023-08-30)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - AWS DataSync introduces Task Reports, a new feature that provides detailed reports of data transfer operations for each task execution.
|
13
|
+
|
4
14
|
1.64.0 (2023-08-04)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.66.0
|
@@ -1665,11 +1665,11 @@ module Aws::DataSync
|
|
1665
1665
|
req.send_request(options)
|
1666
1666
|
end
|
1667
1667
|
|
1668
|
-
# Configures a task, which defines where and how DataSync
|
1669
|
-
# data.
|
1668
|
+
# Configures a transfer task, which defines where and how DataSync moves
|
1669
|
+
# your data.
|
1670
1670
|
#
|
1671
|
-
# A task includes a source location,
|
1672
|
-
#
|
1671
|
+
# A task includes a source location, destination location, and the
|
1672
|
+
# options for how and when you want to transfer your data (such as
|
1673
1673
|
# bandwidth limits, scheduling, among other options).
|
1674
1674
|
#
|
1675
1675
|
# If you're planning to transfer data to or from an Amazon S3 location,
|
@@ -1742,6 +1742,10 @@ module Aws::DataSync
|
|
1742
1742
|
#
|
1743
1743
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
1744
1744
|
#
|
1745
|
+
# @option params [Types::TaskReportConfig] :task_report_config
|
1746
|
+
# Specifies how you want to configure a task report, which provides
|
1747
|
+
# detailed information about for your DataSync transfer.
|
1748
|
+
#
|
1745
1749
|
# @return [Types::CreateTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1746
1750
|
#
|
1747
1751
|
# * {Types::CreateTaskResponse#task_arn #task_arn} => String
|
@@ -1791,6 +1795,32 @@ module Aws::DataSync
|
|
1791
1795
|
# value: "FilterValue",
|
1792
1796
|
# },
|
1793
1797
|
# ],
|
1798
|
+
# task_report_config: {
|
1799
|
+
# destination: {
|
1800
|
+
# s3: {
|
1801
|
+
# subdirectory: "S3Subdirectory",
|
1802
|
+
# s3_bucket_arn: "S3BucketArn", # required
|
1803
|
+
# bucket_access_role_arn: "IamRoleArn", # required
|
1804
|
+
# },
|
1805
|
+
# },
|
1806
|
+
# output_type: "SUMMARY_ONLY", # accepts SUMMARY_ONLY, STANDARD
|
1807
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
1808
|
+
# object_version_ids: "INCLUDE", # accepts INCLUDE, NONE
|
1809
|
+
# overrides: {
|
1810
|
+
# transferred: {
|
1811
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
1812
|
+
# },
|
1813
|
+
# verified: {
|
1814
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
1815
|
+
# },
|
1816
|
+
# deleted: {
|
1817
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
1818
|
+
# },
|
1819
|
+
# skipped: {
|
1820
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
1821
|
+
# },
|
1822
|
+
# },
|
1823
|
+
# },
|
1794
1824
|
# })
|
1795
1825
|
#
|
1796
1826
|
# @example Response structure
|
@@ -1856,7 +1886,7 @@ module Aws::DataSync
|
|
1856
1886
|
req.send_request(options)
|
1857
1887
|
end
|
1858
1888
|
|
1859
|
-
# Deletes an DataSync task.
|
1889
|
+
# Deletes an DataSync transfer task.
|
1860
1890
|
#
|
1861
1891
|
# @option params [required, String] :task_arn
|
1862
1892
|
# Specifies the Amazon Resource Name (ARN) of the task that you want to
|
@@ -2759,6 +2789,7 @@ module Aws::DataSync
|
|
2759
2789
|
# * {Types::DescribeTaskResponse#error_detail #error_detail} => String
|
2760
2790
|
# * {Types::DescribeTaskResponse#creation_time #creation_time} => Time
|
2761
2791
|
# * {Types::DescribeTaskResponse#includes #includes} => Array<Types::FilterRule>
|
2792
|
+
# * {Types::DescribeTaskResponse#task_report_config #task_report_config} => Types::TaskReportConfig
|
2762
2793
|
#
|
2763
2794
|
# @example Request syntax with placeholder values
|
2764
2795
|
#
|
@@ -2804,6 +2835,16 @@ module Aws::DataSync
|
|
2804
2835
|
# resp.includes #=> Array
|
2805
2836
|
# resp.includes[0].filter_type #=> String, one of "SIMPLE_PATTERN"
|
2806
2837
|
# resp.includes[0].value #=> String
|
2838
|
+
# resp.task_report_config.destination.s3.subdirectory #=> String
|
2839
|
+
# resp.task_report_config.destination.s3.s3_bucket_arn #=> String
|
2840
|
+
# resp.task_report_config.destination.s3.bucket_access_role_arn #=> String
|
2841
|
+
# resp.task_report_config.output_type #=> String, one of "SUMMARY_ONLY", "STANDARD"
|
2842
|
+
# resp.task_report_config.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
2843
|
+
# resp.task_report_config.object_version_ids #=> String, one of "INCLUDE", "NONE"
|
2844
|
+
# resp.task_report_config.overrides.transferred.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
2845
|
+
# resp.task_report_config.overrides.verified.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
2846
|
+
# resp.task_report_config.overrides.deleted.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
2847
|
+
# resp.task_report_config.overrides.skipped.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
2807
2848
|
#
|
2808
2849
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTask AWS API Documentation
|
2809
2850
|
#
|
@@ -2814,11 +2855,13 @@ module Aws::DataSync
|
|
2814
2855
|
req.send_request(options)
|
2815
2856
|
end
|
2816
2857
|
|
2817
|
-
# Provides information about an DataSync
|
2858
|
+
# Provides information about an execution of your DataSync task. You can
|
2859
|
+
# use this operation to help monitor the progress of an ongoing transfer
|
2860
|
+
# or check the results of the transfer.
|
2818
2861
|
#
|
2819
2862
|
# @option params [required, String] :task_execution_arn
|
2820
|
-
# Specifies the Amazon Resource Name (ARN) of the
|
2821
|
-
#
|
2863
|
+
# Specifies the Amazon Resource Name (ARN) of the task execution that
|
2864
|
+
# you want information about.
|
2822
2865
|
#
|
2823
2866
|
# @return [Types::DescribeTaskExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2824
2867
|
#
|
@@ -2835,6 +2878,12 @@ module Aws::DataSync
|
|
2835
2878
|
# * {Types::DescribeTaskExecutionResponse#bytes_transferred #bytes_transferred} => Integer
|
2836
2879
|
# * {Types::DescribeTaskExecutionResponse#result #result} => Types::TaskExecutionResultDetail
|
2837
2880
|
# * {Types::DescribeTaskExecutionResponse#bytes_compressed #bytes_compressed} => Integer
|
2881
|
+
# * {Types::DescribeTaskExecutionResponse#task_report_config #task_report_config} => Types::TaskReportConfig
|
2882
|
+
# * {Types::DescribeTaskExecutionResponse#files_deleted #files_deleted} => Integer
|
2883
|
+
# * {Types::DescribeTaskExecutionResponse#files_skipped #files_skipped} => Integer
|
2884
|
+
# * {Types::DescribeTaskExecutionResponse#files_verified #files_verified} => Integer
|
2885
|
+
# * {Types::DescribeTaskExecutionResponse#report_result #report_result} => Types::ReportResult
|
2886
|
+
# * {Types::DescribeTaskExecutionResponse#estimated_files_to_delete #estimated_files_to_delete} => Integer
|
2838
2887
|
#
|
2839
2888
|
# @example Request syntax with placeholder values
|
2840
2889
|
#
|
@@ -2883,6 +2932,23 @@ module Aws::DataSync
|
|
2883
2932
|
# resp.result.error_code #=> String
|
2884
2933
|
# resp.result.error_detail #=> String
|
2885
2934
|
# resp.bytes_compressed #=> Integer
|
2935
|
+
# resp.task_report_config.destination.s3.subdirectory #=> String
|
2936
|
+
# resp.task_report_config.destination.s3.s3_bucket_arn #=> String
|
2937
|
+
# resp.task_report_config.destination.s3.bucket_access_role_arn #=> String
|
2938
|
+
# resp.task_report_config.output_type #=> String, one of "SUMMARY_ONLY", "STANDARD"
|
2939
|
+
# resp.task_report_config.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
2940
|
+
# resp.task_report_config.object_version_ids #=> String, one of "INCLUDE", "NONE"
|
2941
|
+
# resp.task_report_config.overrides.transferred.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
2942
|
+
# resp.task_report_config.overrides.verified.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
2943
|
+
# resp.task_report_config.overrides.deleted.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
2944
|
+
# resp.task_report_config.overrides.skipped.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
2945
|
+
# resp.files_deleted #=> Integer
|
2946
|
+
# resp.files_skipped #=> Integer
|
2947
|
+
# resp.files_verified #=> Integer
|
2948
|
+
# resp.report_result.status #=> String, one of "PENDING", "SUCCESS", "ERROR"
|
2949
|
+
# resp.report_result.error_code #=> String
|
2950
|
+
# resp.report_result.error_detail #=> String
|
2951
|
+
# resp.estimated_files_to_delete #=> Integer
|
2886
2952
|
#
|
2887
2953
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskExecution AWS API Documentation
|
2888
2954
|
#
|
@@ -2902,17 +2968,10 @@ module Aws::DataSync
|
|
2902
2968
|
# Once generated, you can view your recommendations by using the
|
2903
2969
|
# [DescribeStorageSystemResources][2] operation.
|
2904
2970
|
#
|
2905
|
-
# <note markdown="1"> If your [discovery job completes successfully][3], you don't need to
|
2906
|
-
# use this operation. DataSync Discovery generates the recommendations
|
2907
|
-
# for you automatically.
|
2908
|
-
#
|
2909
|
-
# </note>
|
2910
|
-
#
|
2911
2971
|
#
|
2912
2972
|
#
|
2913
2973
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html
|
2914
2974
|
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeStorageSystemResources.html
|
2915
|
-
# [3]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table
|
2916
2975
|
#
|
2917
2976
|
# @option params [required, String] :discovery_job_arn
|
2918
2977
|
# Specifies the Amazon Resource Name (ARN) of the discovery job that
|
@@ -3381,8 +3440,8 @@ module Aws::DataSync
|
|
3381
3440
|
req.send_request(options)
|
3382
3441
|
end
|
3383
3442
|
|
3384
|
-
# Starts an DataSync task. For each task, you can only run one
|
3385
|
-
# execution at a time.
|
3443
|
+
# Starts an DataSync transfer task. For each task, you can only run one
|
3444
|
+
# task execution at a time.
|
3386
3445
|
#
|
3387
3446
|
# There are several phases to a task execution. For more information,
|
3388
3447
|
# see [Task execution statuses][1].
|
@@ -3402,13 +3461,13 @@ module Aws::DataSync
|
|
3402
3461
|
# start.
|
3403
3462
|
#
|
3404
3463
|
# @option params [Types::Options] :override_options
|
3405
|
-
#
|
3406
|
-
# DataSync handles files, objects, and their associated metadata
|
3407
|
-
# also can specify how
|
3408
|
-
# limits for your task, among other options.
|
3464
|
+
# Indicates how your transfer task is configured. These options include
|
3465
|
+
# how DataSync handles files, objects, and their associated metadata
|
3466
|
+
# during your transfer. You also can specify how to verify data
|
3467
|
+
# integrity, set bandwidth limits for your task, among other options.
|
3409
3468
|
#
|
3410
|
-
# Each
|
3411
|
-
#
|
3469
|
+
# Each option has a default value. Unless you need to, you don't have
|
3470
|
+
# to configure any of these options before starting your task.
|
3412
3471
|
#
|
3413
3472
|
# @option params [Array<Types::FilterRule>] :includes
|
3414
3473
|
# Specifies a list of filter rules that determines which files to
|
@@ -3430,6 +3489,10 @@ module Aws::DataSync
|
|
3430
3489
|
# *Tags* are key-value pairs that help you manage, filter, and search
|
3431
3490
|
# for your DataSync resources.
|
3432
3491
|
#
|
3492
|
+
# @option params [Types::TaskReportConfig] :task_report_config
|
3493
|
+
# Specifies how you want to configure a task report, which provides
|
3494
|
+
# detailed information about for your DataSync transfer.
|
3495
|
+
#
|
3433
3496
|
# @return [Types::StartTaskExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3434
3497
|
#
|
3435
3498
|
# * {Types::StartTaskExecutionResponse#task_execution_arn #task_execution_arn} => String
|
@@ -3473,6 +3536,32 @@ module Aws::DataSync
|
|
3473
3536
|
# value: "TagValue",
|
3474
3537
|
# },
|
3475
3538
|
# ],
|
3539
|
+
# task_report_config: {
|
3540
|
+
# destination: {
|
3541
|
+
# s3: {
|
3542
|
+
# subdirectory: "S3Subdirectory",
|
3543
|
+
# s3_bucket_arn: "S3BucketArn", # required
|
3544
|
+
# bucket_access_role_arn: "IamRoleArn", # required
|
3545
|
+
# },
|
3546
|
+
# },
|
3547
|
+
# output_type: "SUMMARY_ONLY", # accepts SUMMARY_ONLY, STANDARD
|
3548
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
3549
|
+
# object_version_ids: "INCLUDE", # accepts INCLUDE, NONE
|
3550
|
+
# overrides: {
|
3551
|
+
# transferred: {
|
3552
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
3553
|
+
# },
|
3554
|
+
# verified: {
|
3555
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
3556
|
+
# },
|
3557
|
+
# deleted: {
|
3558
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
3559
|
+
# },
|
3560
|
+
# skipped: {
|
3561
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
3562
|
+
# },
|
3563
|
+
# },
|
3564
|
+
# },
|
3476
3565
|
# })
|
3477
3566
|
#
|
3478
3567
|
# @example Response structure
|
@@ -4079,20 +4168,20 @@ module Aws::DataSync
|
|
4079
4168
|
req.send_request(options)
|
4080
4169
|
end
|
4081
4170
|
|
4082
|
-
# Updates the
|
4171
|
+
# Updates the configuration of a DataSync transfer task.
|
4083
4172
|
#
|
4084
4173
|
# @option params [required, String] :task_arn
|
4085
4174
|
# The Amazon Resource Name (ARN) of the resource name of the task to
|
4086
4175
|
# update.
|
4087
4176
|
#
|
4088
4177
|
# @option params [Types::Options] :options
|
4089
|
-
#
|
4090
|
-
# DataSync handles files, objects, and their associated metadata
|
4091
|
-
# also can specify how
|
4092
|
-
# limits for your task, among other options.
|
4178
|
+
# Indicates how your transfer task is configured. These options include
|
4179
|
+
# how DataSync handles files, objects, and their associated metadata
|
4180
|
+
# during your transfer. You also can specify how to verify data
|
4181
|
+
# integrity, set bandwidth limits for your task, among other options.
|
4093
4182
|
#
|
4094
|
-
# Each
|
4095
|
-
#
|
4183
|
+
# Each option has a default value. Unless you need to, you don't have
|
4184
|
+
# to configure any of these options before starting your task.
|
4096
4185
|
#
|
4097
4186
|
# @option params [Array<Types::FilterRule>] :excludes
|
4098
4187
|
# Specifies a list of filter rules that exclude specific data during
|
@@ -4131,6 +4220,10 @@ module Aws::DataSync
|
|
4131
4220
|
#
|
4132
4221
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
4133
4222
|
#
|
4223
|
+
# @option params [Types::TaskReportConfig] :task_report_config
|
4224
|
+
# Specifies how you want to configure a task report, which provides
|
4225
|
+
# detailed information about for your DataSync transfer.
|
4226
|
+
#
|
4134
4227
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4135
4228
|
#
|
4136
4229
|
# @example Request syntax with placeholder values
|
@@ -4171,6 +4264,32 @@ module Aws::DataSync
|
|
4171
4264
|
# value: "FilterValue",
|
4172
4265
|
# },
|
4173
4266
|
# ],
|
4267
|
+
# task_report_config: {
|
4268
|
+
# destination: {
|
4269
|
+
# s3: {
|
4270
|
+
# subdirectory: "S3Subdirectory",
|
4271
|
+
# s3_bucket_arn: "S3BucketArn", # required
|
4272
|
+
# bucket_access_role_arn: "IamRoleArn", # required
|
4273
|
+
# },
|
4274
|
+
# },
|
4275
|
+
# output_type: "SUMMARY_ONLY", # accepts SUMMARY_ONLY, STANDARD
|
4276
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
4277
|
+
# object_version_ids: "INCLUDE", # accepts INCLUDE, NONE
|
4278
|
+
# overrides: {
|
4279
|
+
# transferred: {
|
4280
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
4281
|
+
# },
|
4282
|
+
# verified: {
|
4283
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
4284
|
+
# },
|
4285
|
+
# deleted: {
|
4286
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
4287
|
+
# },
|
4288
|
+
# skipped: {
|
4289
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
4290
|
+
# },
|
4291
|
+
# },
|
4292
|
+
# },
|
4174
4293
|
# })
|
4175
4294
|
#
|
4176
4295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTask AWS API Documentation
|
@@ -4182,11 +4301,11 @@ module Aws::DataSync
|
|
4182
4301
|
req.send_request(options)
|
4183
4302
|
end
|
4184
4303
|
|
4185
|
-
#
|
4304
|
+
# Updates the configuration of a running DataSync task execution.
|
4186
4305
|
#
|
4187
4306
|
# <note markdown="1"> Currently, the only `Option` that you can modify with
|
4188
4307
|
# `UpdateTaskExecution` is ` BytesPerSecond `, which throttles bandwidth
|
4189
|
-
# for a running or queued task.
|
4308
|
+
# for a running or queued task execution.
|
4190
4309
|
#
|
4191
4310
|
# </note>
|
4192
4311
|
#
|
@@ -4195,13 +4314,13 @@ module Aws::DataSync
|
|
4195
4314
|
# you're updating.
|
4196
4315
|
#
|
4197
4316
|
# @option params [required, Types::Options] :options
|
4198
|
-
#
|
4199
|
-
# DataSync handles files, objects, and their associated metadata
|
4200
|
-
# also can specify how
|
4201
|
-
# limits for your task, among other options.
|
4317
|
+
# Indicates how your transfer task is configured. These options include
|
4318
|
+
# how DataSync handles files, objects, and their associated metadata
|
4319
|
+
# during your transfer. You also can specify how to verify data
|
4320
|
+
# integrity, set bandwidth limits for your task, among other options.
|
4202
4321
|
#
|
4203
|
-
# Each
|
4204
|
-
#
|
4322
|
+
# Each option has a default value. Unless you need to, you don't have
|
4323
|
+
# to configure any of these options before starting your task.
|
4205
4324
|
#
|
4206
4325
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4207
4326
|
#
|
@@ -4250,7 +4369,7 @@ module Aws::DataSync
|
|
4250
4369
|
params: params,
|
4251
4370
|
config: config)
|
4252
4371
|
context[:gem_name] = 'aws-sdk-datasync'
|
4253
|
-
context[:gem_version] = '1.
|
4372
|
+
context[:gem_version] = '1.66.0'
|
4254
4373
|
Seahorse::Client::Request.new(handlers, context)
|
4255
4374
|
end
|
4256
4375
|
|
@@ -218,6 +218,7 @@ module Aws::DataSync
|
|
218
218
|
ObjectStorageServerPort = Shapes::IntegerShape.new(name: 'ObjectStorageServerPort')
|
219
219
|
ObjectStorageServerProtocol = Shapes::StringShape.new(name: 'ObjectStorageServerProtocol')
|
220
220
|
ObjectTags = Shapes::StringShape.new(name: 'ObjectTags')
|
221
|
+
ObjectVersionIds = Shapes::StringShape.new(name: 'ObjectVersionIds')
|
221
222
|
OnPremConfig = Shapes::StructureShape.new(name: 'OnPremConfig')
|
222
223
|
Operator = Shapes::StringShape.new(name: 'Operator')
|
223
224
|
Options = Shapes::StructureShape.new(name: 'Options')
|
@@ -243,6 +244,13 @@ module Aws::DataSync
|
|
243
244
|
RecommendationsConfigMap = Shapes::MapShape.new(name: 'RecommendationsConfigMap')
|
244
245
|
RemoveStorageSystemRequest = Shapes::StructureShape.new(name: 'RemoveStorageSystemRequest')
|
245
246
|
RemoveStorageSystemResponse = Shapes::StructureShape.new(name: 'RemoveStorageSystemResponse')
|
247
|
+
ReportDestination = Shapes::StructureShape.new(name: 'ReportDestination')
|
248
|
+
ReportDestinationS3 = Shapes::StructureShape.new(name: 'ReportDestinationS3')
|
249
|
+
ReportLevel = Shapes::StringShape.new(name: 'ReportLevel')
|
250
|
+
ReportOutputType = Shapes::StringShape.new(name: 'ReportOutputType')
|
251
|
+
ReportOverride = Shapes::StructureShape.new(name: 'ReportOverride')
|
252
|
+
ReportOverrides = Shapes::StructureShape.new(name: 'ReportOverrides')
|
253
|
+
ReportResult = Shapes::StructureShape.new(name: 'ReportResult')
|
246
254
|
ResourceDetails = Shapes::StructureShape.new(name: 'ResourceDetails')
|
247
255
|
ResourceFilters = Shapes::MapShape.new(name: 'ResourceFilters')
|
248
256
|
ResourceId = Shapes::StringShape.new(name: 'ResourceId')
|
@@ -293,6 +301,7 @@ module Aws::DataSync
|
|
293
301
|
TaskList = Shapes::ListShape.new(name: 'TaskList')
|
294
302
|
TaskListEntry = Shapes::StructureShape.new(name: 'TaskListEntry')
|
295
303
|
TaskQueueing = Shapes::StringShape.new(name: 'TaskQueueing')
|
304
|
+
TaskReportConfig = Shapes::StructureShape.new(name: 'TaskReportConfig')
|
296
305
|
TaskSchedule = Shapes::StructureShape.new(name: 'TaskSchedule')
|
297
306
|
TaskStatus = Shapes::StringShape.new(name: 'TaskStatus')
|
298
307
|
Throughput = Shapes::StructureShape.new(name: 'Throughput')
|
@@ -516,6 +525,7 @@ module Aws::DataSync
|
|
516
525
|
CreateTaskRequest.add_member(:schedule, Shapes::ShapeRef.new(shape: TaskSchedule, location_name: "Schedule"))
|
517
526
|
CreateTaskRequest.add_member(:tags, Shapes::ShapeRef.new(shape: InputTagList, location_name: "Tags"))
|
518
527
|
CreateTaskRequest.add_member(:includes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Includes"))
|
528
|
+
CreateTaskRequest.add_member(:task_report_config, Shapes::ShapeRef.new(shape: TaskReportConfig, location_name: "TaskReportConfig"))
|
519
529
|
CreateTaskRequest.struct_class = Types::CreateTaskRequest
|
520
530
|
|
521
531
|
CreateTaskResponse.add_member(:task_arn, Shapes::ShapeRef.new(shape: TaskArn, location_name: "TaskArn"))
|
@@ -748,6 +758,12 @@ module Aws::DataSync
|
|
748
758
|
DescribeTaskExecutionResponse.add_member(:bytes_transferred, Shapes::ShapeRef.new(shape: long, location_name: "BytesTransferred"))
|
749
759
|
DescribeTaskExecutionResponse.add_member(:result, Shapes::ShapeRef.new(shape: TaskExecutionResultDetail, location_name: "Result"))
|
750
760
|
DescribeTaskExecutionResponse.add_member(:bytes_compressed, Shapes::ShapeRef.new(shape: long, location_name: "BytesCompressed"))
|
761
|
+
DescribeTaskExecutionResponse.add_member(:task_report_config, Shapes::ShapeRef.new(shape: TaskReportConfig, location_name: "TaskReportConfig"))
|
762
|
+
DescribeTaskExecutionResponse.add_member(:files_deleted, Shapes::ShapeRef.new(shape: long, location_name: "FilesDeleted"))
|
763
|
+
DescribeTaskExecutionResponse.add_member(:files_skipped, Shapes::ShapeRef.new(shape: long, location_name: "FilesSkipped"))
|
764
|
+
DescribeTaskExecutionResponse.add_member(:files_verified, Shapes::ShapeRef.new(shape: long, location_name: "FilesVerified"))
|
765
|
+
DescribeTaskExecutionResponse.add_member(:report_result, Shapes::ShapeRef.new(shape: ReportResult, location_name: "ReportResult"))
|
766
|
+
DescribeTaskExecutionResponse.add_member(:estimated_files_to_delete, Shapes::ShapeRef.new(shape: long, location_name: "EstimatedFilesToDelete"))
|
751
767
|
DescribeTaskExecutionResponse.struct_class = Types::DescribeTaskExecutionResponse
|
752
768
|
|
753
769
|
DescribeTaskRequest.add_member(:task_arn, Shapes::ShapeRef.new(shape: TaskArn, required: true, location_name: "TaskArn"))
|
@@ -769,6 +785,7 @@ module Aws::DataSync
|
|
769
785
|
DescribeTaskResponse.add_member(:error_detail, Shapes::ShapeRef.new(shape: string, location_name: "ErrorDetail"))
|
770
786
|
DescribeTaskResponse.add_member(:creation_time, Shapes::ShapeRef.new(shape: Time, location_name: "CreationTime"))
|
771
787
|
DescribeTaskResponse.add_member(:includes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Includes"))
|
788
|
+
DescribeTaskResponse.add_member(:task_report_config, Shapes::ShapeRef.new(shape: TaskReportConfig, location_name: "TaskReportConfig"))
|
772
789
|
DescribeTaskResponse.struct_class = Types::DescribeTaskResponse
|
773
790
|
|
774
791
|
DestinationNetworkInterfaceArns.member = Shapes::ShapeRef.new(shape: NetworkInterfaceArn)
|
@@ -1052,6 +1069,28 @@ module Aws::DataSync
|
|
1052
1069
|
|
1053
1070
|
RemoveStorageSystemResponse.struct_class = Types::RemoveStorageSystemResponse
|
1054
1071
|
|
1072
|
+
ReportDestination.add_member(:s3, Shapes::ShapeRef.new(shape: ReportDestinationS3, location_name: "S3"))
|
1073
|
+
ReportDestination.struct_class = Types::ReportDestination
|
1074
|
+
|
1075
|
+
ReportDestinationS3.add_member(:subdirectory, Shapes::ShapeRef.new(shape: S3Subdirectory, location_name: "Subdirectory"))
|
1076
|
+
ReportDestinationS3.add_member(:s3_bucket_arn, Shapes::ShapeRef.new(shape: S3BucketArn, required: true, location_name: "S3BucketArn"))
|
1077
|
+
ReportDestinationS3.add_member(:bucket_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "BucketAccessRoleArn"))
|
1078
|
+
ReportDestinationS3.struct_class = Types::ReportDestinationS3
|
1079
|
+
|
1080
|
+
ReportOverride.add_member(:report_level, Shapes::ShapeRef.new(shape: ReportLevel, location_name: "ReportLevel"))
|
1081
|
+
ReportOverride.struct_class = Types::ReportOverride
|
1082
|
+
|
1083
|
+
ReportOverrides.add_member(:transferred, Shapes::ShapeRef.new(shape: ReportOverride, location_name: "Transferred"))
|
1084
|
+
ReportOverrides.add_member(:verified, Shapes::ShapeRef.new(shape: ReportOverride, location_name: "Verified"))
|
1085
|
+
ReportOverrides.add_member(:deleted, Shapes::ShapeRef.new(shape: ReportOverride, location_name: "Deleted"))
|
1086
|
+
ReportOverrides.add_member(:skipped, Shapes::ShapeRef.new(shape: ReportOverride, location_name: "Skipped"))
|
1087
|
+
ReportOverrides.struct_class = Types::ReportOverrides
|
1088
|
+
|
1089
|
+
ReportResult.add_member(:status, Shapes::ShapeRef.new(shape: PhaseStatus, location_name: "Status"))
|
1090
|
+
ReportResult.add_member(:error_code, Shapes::ShapeRef.new(shape: string, location_name: "ErrorCode"))
|
1091
|
+
ReportResult.add_member(:error_detail, Shapes::ShapeRef.new(shape: string, location_name: "ErrorDetail"))
|
1092
|
+
ReportResult.struct_class = Types::ReportResult
|
1093
|
+
|
1055
1094
|
ResourceDetails.add_member(:net_app_ontapsv_ms, Shapes::ShapeRef.new(shape: NetAppONTAPSVMs, location_name: "NetAppONTAPSVMs"))
|
1056
1095
|
ResourceDetails.add_member(:net_app_ontap_volumes, Shapes::ShapeRef.new(shape: NetAppONTAPVolumes, location_name: "NetAppONTAPVolumes"))
|
1057
1096
|
ResourceDetails.add_member(:net_app_ontap_clusters, Shapes::ShapeRef.new(shape: NetAppONTAPClusters, location_name: "NetAppONTAPClusters"))
|
@@ -1091,6 +1130,7 @@ module Aws::DataSync
|
|
1091
1130
|
StartTaskExecutionRequest.add_member(:includes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Includes"))
|
1092
1131
|
StartTaskExecutionRequest.add_member(:excludes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Excludes"))
|
1093
1132
|
StartTaskExecutionRequest.add_member(:tags, Shapes::ShapeRef.new(shape: InputTagList, location_name: "Tags"))
|
1133
|
+
StartTaskExecutionRequest.add_member(:task_report_config, Shapes::ShapeRef.new(shape: TaskReportConfig, location_name: "TaskReportConfig"))
|
1094
1134
|
StartTaskExecutionRequest.struct_class = Types::StartTaskExecutionRequest
|
1095
1135
|
|
1096
1136
|
StartTaskExecutionResponse.add_member(:task_execution_arn, Shapes::ShapeRef.new(shape: TaskExecutionArn, location_name: "TaskExecutionArn"))
|
@@ -1150,6 +1190,13 @@ module Aws::DataSync
|
|
1150
1190
|
TaskListEntry.add_member(:name, Shapes::ShapeRef.new(shape: TagValue, location_name: "Name"))
|
1151
1191
|
TaskListEntry.struct_class = Types::TaskListEntry
|
1152
1192
|
|
1193
|
+
TaskReportConfig.add_member(:destination, Shapes::ShapeRef.new(shape: ReportDestination, location_name: "Destination"))
|
1194
|
+
TaskReportConfig.add_member(:output_type, Shapes::ShapeRef.new(shape: ReportOutputType, location_name: "OutputType"))
|
1195
|
+
TaskReportConfig.add_member(:report_level, Shapes::ShapeRef.new(shape: ReportLevel, location_name: "ReportLevel"))
|
1196
|
+
TaskReportConfig.add_member(:object_version_ids, Shapes::ShapeRef.new(shape: ObjectVersionIds, location_name: "ObjectVersionIds"))
|
1197
|
+
TaskReportConfig.add_member(:overrides, Shapes::ShapeRef.new(shape: ReportOverrides, location_name: "Overrides"))
|
1198
|
+
TaskReportConfig.struct_class = Types::TaskReportConfig
|
1199
|
+
|
1153
1200
|
TaskSchedule.add_member(:schedule_expression, Shapes::ShapeRef.new(shape: ScheduleExpressionCron, required: true, location_name: "ScheduleExpression"))
|
1154
1201
|
TaskSchedule.struct_class = Types::TaskSchedule
|
1155
1202
|
|
@@ -1259,6 +1306,7 @@ module Aws::DataSync
|
|
1259
1306
|
UpdateTaskRequest.add_member(:name, Shapes::ShapeRef.new(shape: TagValue, location_name: "Name"))
|
1260
1307
|
UpdateTaskRequest.add_member(:cloud_watch_log_group_arn, Shapes::ShapeRef.new(shape: LogGroupArn, location_name: "CloudWatchLogGroupArn"))
|
1261
1308
|
UpdateTaskRequest.add_member(:includes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Includes"))
|
1309
|
+
UpdateTaskRequest.add_member(:task_report_config, Shapes::ShapeRef.new(shape: TaskReportConfig, location_name: "TaskReportConfig"))
|
1262
1310
|
UpdateTaskRequest.struct_class = Types::UpdateTaskRequest
|
1263
1311
|
|
1264
1312
|
UpdateTaskResponse.struct_class = Types::UpdateTaskResponse
|
@@ -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:
|
@@ -1282,6 +1282,11 @@ module Aws::DataSync
|
|
1282
1282
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
1283
1283
|
# @return [Array<Types::FilterRule>]
|
1284
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
|
+
#
|
1285
1290
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTaskRequest AWS API Documentation
|
1286
1291
|
#
|
1287
1292
|
class CreateTaskRequest < Struct.new(
|
@@ -1293,7 +1298,8 @@ module Aws::DataSync
|
|
1293
1298
|
:excludes,
|
1294
1299
|
:schedule,
|
1295
1300
|
:tags,
|
1296
|
-
:includes
|
1301
|
+
:includes,
|
1302
|
+
:task_report_config)
|
1297
1303
|
SENSITIVE = []
|
1298
1304
|
include Aws::Structure
|
1299
1305
|
end
|
@@ -2446,8 +2452,8 @@ module Aws::DataSync
|
|
2446
2452
|
# DescribeTaskExecutionRequest
|
2447
2453
|
#
|
2448
2454
|
# @!attribute [rw] task_execution_arn
|
2449
|
-
# Specifies the Amazon Resource Name (ARN) of the
|
2450
|
-
#
|
2455
|
+
# Specifies the Amazon Resource Name (ARN) of the task execution that
|
2456
|
+
# you want information about.
|
2451
2457
|
# @return [String]
|
2452
2458
|
#
|
2453
2459
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskExecutionRequest AWS API Documentation
|
@@ -2461,9 +2467,9 @@ module Aws::DataSync
|
|
2461
2467
|
# DescribeTaskExecutionResponse
|
2462
2468
|
#
|
2463
2469
|
# @!attribute [rw] task_execution_arn
|
2464
|
-
# The
|
2465
|
-
#
|
2466
|
-
#
|
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.
|
2467
2473
|
#
|
2468
2474
|
# For example, a `TaskExecution` value with the ARN
|
2469
2475
|
# `arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b`
|
@@ -2473,20 +2479,17 @@ module Aws::DataSync
|
|
2473
2479
|
#
|
2474
2480
|
# @!attribute [rw] status
|
2475
2481
|
# The status of the task execution.
|
2476
|
-
#
|
2477
|
-
# For detailed information about task execution statuses, see
|
2478
|
-
# Understanding Task Statuses in the *DataSync User Guide.*
|
2479
2482
|
# @return [String]
|
2480
2483
|
#
|
2481
2484
|
# @!attribute [rw] options
|
2482
|
-
#
|
2483
|
-
# DataSync handles files, objects, and their associated
|
2484
|
-
# also can specify how
|
2485
|
-
# limits for your task, among other
|
2486
|
-
#
|
2487
|
-
#
|
2488
|
-
#
|
2489
|
-
# 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.
|
2490
2493
|
# @return [Types::Options]
|
2491
2494
|
#
|
2492
2495
|
# @!attribute [rw] excludes
|
@@ -2510,41 +2513,39 @@ module Aws::DataSync
|
|
2510
2513
|
# @return [Array<Types::FilterRule>]
|
2511
2514
|
#
|
2512
2515
|
# @!attribute [rw] start_time
|
2513
|
-
# The time
|
2516
|
+
# The time when the task execution started.
|
2514
2517
|
# @return [Time]
|
2515
2518
|
#
|
2516
2519
|
# @!attribute [rw] estimated_files_to_transfer
|
2517
|
-
# The expected number of files
|
2518
|
-
# network. This value is calculated during the
|
2519
|
-
#
|
2520
|
-
#
|
2521
|
-
#
|
2522
|
-
#
|
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.
|
2523
2526
|
# @return [Integer]
|
2524
2527
|
#
|
2525
2528
|
# @!attribute [rw] estimated_bytes_to_transfer
|
2526
|
-
# The estimated physical number of bytes that
|
2527
|
-
#
|
2529
|
+
# The estimated physical number of bytes that will transfer over the
|
2530
|
+
# network.
|
2528
2531
|
# @return [Integer]
|
2529
2532
|
#
|
2530
2533
|
# @!attribute [rw] files_transferred
|
2531
|
-
# The actual number of files
|
2532
|
-
# This value is
|
2533
|
-
#
|
2534
|
-
#
|
2535
|
-
# 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.
|
2536
2538
|
#
|
2537
|
-
# If
|
2539
|
+
# If DataSync fails to transfer something, this value can be less than
|
2538
2540
|
# `EstimatedFilesToTransfer`. In some cases, this value can also be
|
2539
2541
|
# greater than `EstimatedFilesToTransfer`. This element is
|
2540
2542
|
# implementation-specific for some location types, so don't use it as
|
2541
|
-
# an
|
2543
|
+
# an exact indication of what transferred or to monitor your task
|
2542
2544
|
# execution.
|
2543
2545
|
# @return [Integer]
|
2544
2546
|
#
|
2545
2547
|
# @!attribute [rw] bytes_written
|
2546
|
-
# The number of logical bytes written to the destination
|
2547
|
-
# Services storage resource.
|
2548
|
+
# The number of logical bytes written to the destination location.
|
2548
2549
|
# @return [Integer]
|
2549
2550
|
#
|
2550
2551
|
# @!attribute [rw] bytes_transferred
|
@@ -2562,6 +2563,52 @@ module Aws::DataSync
|
|
2562
2563
|
# `BytesTransferred` unless the data isn't compressible.
|
2563
2564
|
# @return [Integer]
|
2564
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
|
+
#
|
2565
2612
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskExecutionResponse AWS API Documentation
|
2566
2613
|
#
|
2567
2614
|
class DescribeTaskExecutionResponse < Struct.new(
|
@@ -2577,7 +2624,13 @@ module Aws::DataSync
|
|
2577
2624
|
:bytes_written,
|
2578
2625
|
:bytes_transferred,
|
2579
2626
|
:result,
|
2580
|
-
: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)
|
2581
2634
|
SENSITIVE = []
|
2582
2635
|
include Aws::Structure
|
2583
2636
|
end
|
@@ -2709,6 +2762,15 @@ module Aws::DataSync
|
|
2709
2762
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
2710
2763
|
# @return [Array<Types::FilterRule>]
|
2711
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
|
+
#
|
2712
2774
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskResponse AWS API Documentation
|
2713
2775
|
#
|
2714
2776
|
class DescribeTaskResponse < Struct.new(
|
@@ -2727,7 +2789,8 @@ module Aws::DataSync
|
|
2727
2789
|
:error_code,
|
2728
2790
|
:error_detail,
|
2729
2791
|
:creation_time,
|
2730
|
-
:includes
|
2792
|
+
:includes,
|
2793
|
+
:task_report_config)
|
2731
2794
|
SENSITIVE = []
|
2732
2795
|
include Aws::Structure
|
2733
2796
|
end
|
@@ -3895,13 +3958,13 @@ module Aws::DataSync
|
|
3895
3958
|
include Aws::Structure
|
3896
3959
|
end
|
3897
3960
|
|
3898
|
-
#
|
3899
|
-
# DataSync handles files, objects, and their associated metadata
|
3900
|
-
# also can specify how
|
3901
|
-
# 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.
|
3902
3965
|
#
|
3903
|
-
# Each
|
3904
|
-
#
|
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.
|
3905
3968
|
#
|
3906
3969
|
# @!attribute [rw] verify_mode
|
3907
3970
|
# Specifies how and when DataSync checks the integrity of your data
|
@@ -4377,6 +4440,169 @@ module Aws::DataSync
|
|
4377
4440
|
#
|
4378
4441
|
class RemoveStorageSystemResponse < Aws::EmptyStructure; end
|
4379
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.
|
4546
|
+
# @return [Types::ReportOverride]
|
4547
|
+
#
|
4548
|
+
# @!attribute [rw] deleted
|
4549
|
+
# Specifies the level of reporting for the files, objects, and
|
4550
|
+
# directories that DataSync attempted to delete in your destination
|
4551
|
+
# location. This only applies if you [configure your task][1] to
|
4552
|
+
# delete data in the destination that isn't in the source.
|
4553
|
+
#
|
4554
|
+
#
|
4555
|
+
#
|
4556
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html
|
4557
|
+
# @return [Types::ReportOverride]
|
4558
|
+
#
|
4559
|
+
# @!attribute [rw] skipped
|
4560
|
+
# Specifies the level of reporting for the files, objects, and
|
4561
|
+
# directories that DataSync attempted to skip during your transfer.
|
4562
|
+
# @return [Types::ReportOverride]
|
4563
|
+
#
|
4564
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ReportOverrides AWS API Documentation
|
4565
|
+
#
|
4566
|
+
class ReportOverrides < Struct.new(
|
4567
|
+
:transferred,
|
4568
|
+
:verified,
|
4569
|
+
:deleted,
|
4570
|
+
:skipped)
|
4571
|
+
SENSITIVE = []
|
4572
|
+
include Aws::Structure
|
4573
|
+
end
|
4574
|
+
|
4575
|
+
# Indicates whether DataSync created a complete [task report][1] for
|
4576
|
+
# your transfer.
|
4577
|
+
#
|
4578
|
+
#
|
4579
|
+
#
|
4580
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
|
4581
|
+
#
|
4582
|
+
# @!attribute [rw] status
|
4583
|
+
# Indicates whether DataSync is still working on your report, created
|
4584
|
+
# a report, or can't create a complete report.
|
4585
|
+
# @return [String]
|
4586
|
+
#
|
4587
|
+
# @!attribute [rw] error_code
|
4588
|
+
# Indicates the code associated with the error if DataSync can't
|
4589
|
+
# create a complete report.
|
4590
|
+
# @return [String]
|
4591
|
+
#
|
4592
|
+
# @!attribute [rw] error_detail
|
4593
|
+
# Provides details about issues creating a report.
|
4594
|
+
# @return [String]
|
4595
|
+
#
|
4596
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ReportResult AWS API Documentation
|
4597
|
+
#
|
4598
|
+
class ReportResult < Struct.new(
|
4599
|
+
:status,
|
4600
|
+
:error_code,
|
4601
|
+
:error_detail)
|
4602
|
+
SENSITIVE = []
|
4603
|
+
include Aws::Structure
|
4604
|
+
end
|
4605
|
+
|
4380
4606
|
# Information provided by DataSync Discovery about the resources in your
|
4381
4607
|
# on-premises storage system.
|
4382
4608
|
#
|
@@ -4573,14 +4799,14 @@ module Aws::DataSync
|
|
4573
4799
|
# @return [String]
|
4574
4800
|
#
|
4575
4801
|
# @!attribute [rw] override_options
|
4576
|
-
#
|
4577
|
-
# DataSync handles files, objects, and their associated
|
4578
|
-
# also can specify how
|
4579
|
-
# limits for your task, among other
|
4580
|
-
#
|
4581
|
-
#
|
4582
|
-
#
|
4583
|
-
# task.
|
4802
|
+
# Indicates how your transfer task is configured. These options
|
4803
|
+
# include how DataSync handles files, objects, and their associated
|
4804
|
+
# metadata during your transfer. You also can specify how to verify
|
4805
|
+
# data integrity, set bandwidth limits for your task, among other
|
4806
|
+
# options.
|
4807
|
+
#
|
4808
|
+
# Each option has a default value. Unless you need to, you don't have
|
4809
|
+
# to configure any of these options before starting your task.
|
4584
4810
|
# @return [Types::Options]
|
4585
4811
|
#
|
4586
4812
|
# @!attribute [rw] includes
|
@@ -4606,6 +4832,11 @@ module Aws::DataSync
|
|
4606
4832
|
# for your DataSync resources.
|
4607
4833
|
# @return [Array<Types::TagListEntry>]
|
4608
4834
|
#
|
4835
|
+
# @!attribute [rw] task_report_config
|
4836
|
+
# Specifies how you want to configure a task report, which provides
|
4837
|
+
# detailed information about for your DataSync transfer.
|
4838
|
+
# @return [Types::TaskReportConfig]
|
4839
|
+
#
|
4609
4840
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartTaskExecutionRequest AWS API Documentation
|
4610
4841
|
#
|
4611
4842
|
class StartTaskExecutionRequest < Struct.new(
|
@@ -4613,7 +4844,8 @@ module Aws::DataSync
|
|
4613
4844
|
:override_options,
|
4614
4845
|
:includes,
|
4615
4846
|
:excludes,
|
4616
|
-
:tags
|
4847
|
+
:tags,
|
4848
|
+
:task_report_config)
|
4617
4849
|
SENSITIVE = []
|
4618
4850
|
include Aws::Structure
|
4619
4851
|
end
|
@@ -4872,6 +5104,79 @@ module Aws::DataSync
|
|
4872
5104
|
include Aws::Structure
|
4873
5105
|
end
|
4874
5106
|
|
5107
|
+
# Specifies how you want to configure a task report, which provides
|
5108
|
+
# detailed information about for your DataSync transfer.
|
5109
|
+
#
|
5110
|
+
# For more information, see [Task reports][1].
|
5111
|
+
#
|
5112
|
+
#
|
5113
|
+
#
|
5114
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html
|
5115
|
+
#
|
5116
|
+
# @!attribute [rw] destination
|
5117
|
+
# Specifies the Amazon S3 bucket where DataSync uploads your task
|
5118
|
+
# report. For more information, see [Task reports][1].
|
5119
|
+
#
|
5120
|
+
#
|
5121
|
+
#
|
5122
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-task-reports.html#task-report-access
|
5123
|
+
# @return [Types::ReportDestination]
|
5124
|
+
#
|
5125
|
+
# @!attribute [rw] output_type
|
5126
|
+
# Specifies the type of task report that you want:
|
5127
|
+
#
|
5128
|
+
# * `SUMMARY_ONLY`: Provides necessary details about your task,
|
5129
|
+
# including the number of files, objects, and directories
|
5130
|
+
# transferred and transfer duration.
|
5131
|
+
#
|
5132
|
+
# * `STANDARD`: Provides complete details about your task, including a
|
5133
|
+
# full list of files, objects, and directories that were
|
5134
|
+
# transferred, skipped, verified, and more.
|
5135
|
+
# @return [String]
|
5136
|
+
#
|
5137
|
+
# @!attribute [rw] report_level
|
5138
|
+
# Specifies whether you want your task report to include only what
|
5139
|
+
# went wrong with your transfer or a list of what succeeded and
|
5140
|
+
# didn't.
|
5141
|
+
#
|
5142
|
+
# * `ERRORS_ONLY`: A report shows what DataSync was unable to
|
5143
|
+
# transfer, skip, verify, and delete.
|
5144
|
+
#
|
5145
|
+
# * `SUCCESSES_AND_ERRORS`: A report shows what DataSync was able and
|
5146
|
+
# unable to transfer, skip, verify, and delete.
|
5147
|
+
# @return [String]
|
5148
|
+
#
|
5149
|
+
# @!attribute [rw] object_version_ids
|
5150
|
+
# Specifies whether your task report includes the new version of each
|
5151
|
+
# object transferred into an S3 bucket. This only applies if you
|
5152
|
+
# [enable versioning on your bucket][1]. Keep in mind that setting
|
5153
|
+
# this to `INCLUDE` can increase the duration of your task execution.
|
5154
|
+
#
|
5155
|
+
#
|
5156
|
+
#
|
5157
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html
|
5158
|
+
# @return [String]
|
5159
|
+
#
|
5160
|
+
# @!attribute [rw] overrides
|
5161
|
+
# Customizes the reporting level for aspects of your task report. For
|
5162
|
+
# example, your report might generally only include errors, but you
|
5163
|
+
# could specify that you want a list of successes and errors just for
|
5164
|
+
# the files that DataSync attempted to delete in your destination
|
5165
|
+
# location.
|
5166
|
+
# @return [Types::ReportOverrides]
|
5167
|
+
#
|
5168
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskReportConfig AWS API Documentation
|
5169
|
+
#
|
5170
|
+
class TaskReportConfig < Struct.new(
|
5171
|
+
:destination,
|
5172
|
+
:output_type,
|
5173
|
+
:report_level,
|
5174
|
+
:object_version_ids,
|
5175
|
+
:overrides)
|
5176
|
+
SENSITIVE = []
|
5177
|
+
include Aws::Structure
|
5178
|
+
end
|
5179
|
+
|
4875
5180
|
# Specifies the schedule you want your task to use for repeated
|
4876
5181
|
# executions. For more information, see [Schedule Expressions for
|
4877
5182
|
# Rules][1].
|
@@ -5399,14 +5704,14 @@ module Aws::DataSync
|
|
5399
5704
|
# @return [String]
|
5400
5705
|
#
|
5401
5706
|
# @!attribute [rw] options
|
5402
|
-
#
|
5403
|
-
# DataSync handles files, objects, and their associated
|
5404
|
-
# also can specify how
|
5405
|
-
# limits for your task, among other
|
5406
|
-
#
|
5407
|
-
#
|
5408
|
-
#
|
5409
|
-
# task.
|
5707
|
+
# Indicates how your transfer task is configured. These options
|
5708
|
+
# include how DataSync handles files, objects, and their associated
|
5709
|
+
# metadata during your transfer. You also can specify how to verify
|
5710
|
+
# data integrity, set bandwidth limits for your task, among other
|
5711
|
+
# options.
|
5712
|
+
#
|
5713
|
+
# Each option has a default value. Unless you need to, you don't have
|
5714
|
+
# to configure any of these options before starting your task.
|
5410
5715
|
# @return [Types::Options]
|
5411
5716
|
#
|
5412
5717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecutionRequest AWS API Documentation
|
@@ -5430,14 +5735,14 @@ module Aws::DataSync
|
|
5430
5735
|
# @return [String]
|
5431
5736
|
#
|
5432
5737
|
# @!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.
|
5738
|
+
# Indicates how your transfer task is configured. These options
|
5739
|
+
# include how DataSync handles files, objects, and their associated
|
5740
|
+
# metadata during your transfer. You also can specify how to verify
|
5741
|
+
# data integrity, set bandwidth limits for your task, among other
|
5742
|
+
# options.
|
5743
|
+
#
|
5744
|
+
# Each option has a default value. Unless you need to, you don't have
|
5745
|
+
# to configure any of these options before starting your task.
|
5441
5746
|
# @return [Types::Options]
|
5442
5747
|
#
|
5443
5748
|
# @!attribute [rw] excludes
|
@@ -5482,6 +5787,11 @@ module Aws::DataSync
|
|
5482
5787
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
5483
5788
|
# @return [Array<Types::FilterRule>]
|
5484
5789
|
#
|
5790
|
+
# @!attribute [rw] task_report_config
|
5791
|
+
# Specifies how you want to configure a task report, which provides
|
5792
|
+
# detailed information about for your DataSync transfer.
|
5793
|
+
# @return [Types::TaskReportConfig]
|
5794
|
+
#
|
5485
5795
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskRequest AWS API Documentation
|
5486
5796
|
#
|
5487
5797
|
class UpdateTaskRequest < Struct.new(
|
@@ -5491,7 +5801,8 @@ module Aws::DataSync
|
|
5491
5801
|
:schedule,
|
5492
5802
|
:name,
|
5493
5803
|
:cloud_watch_log_group_arn,
|
5494
|
-
:includes
|
5804
|
+
:includes,
|
5805
|
+
:task_report_config)
|
5495
5806
|
SENSITIVE = []
|
5496
5807
|
include Aws::Structure
|
5497
5808
|
end
|
data/lib/aws-sdk-datasync.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-datasync
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.66.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-09-15 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|