aws-sdk-datasync 1.64.0 → 1.65.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-datasync/client.rb +158 -32
- data/lib/aws-sdk-datasync/client_api.rb +48 -0
- data/lib/aws-sdk-datasync/types.rb +388 -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: 6f9f352fa22503339a8961f2b68bde03a8843a13fe70c4b256ca106a8f8bb1d0
|
4
|
+
data.tar.gz: a43bb69777e189bccb2ef2acfb0dbad028eb943c78178637554e1f44d0be2114
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 928cbf6fe41e7079cd258a776890226a572f7542dbe9b46ede9e1a47ce17b0e493bcb33e800fb5dadb4f6603f157b47d4f4b9af819a297afbbdeac403ce8e838
|
7
|
+
data.tar.gz: a3f02df725fce3d709ba9dbfe86923d79151a92ede7186c10c5ebf75a8c345dfc05f9353271c691f014a370407c0e2d3c38f742bf0ae4e895be9d8ba1e3a3271
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.65.0 (2023-08-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - AWS DataSync introduces Task Reports, a new feature that provides detailed reports of data transfer operations for each task execution.
|
8
|
+
|
4
9
|
1.64.0 (2023-08-04)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.65.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
|
#
|
@@ -3381,8 +3447,8 @@ module Aws::DataSync
|
|
3381
3447
|
req.send_request(options)
|
3382
3448
|
end
|
3383
3449
|
|
3384
|
-
# Starts an DataSync task. For each task, you can only run one
|
3385
|
-
# execution at a time.
|
3450
|
+
# Starts an DataSync transfer task. For each task, you can only run one
|
3451
|
+
# task execution at a time.
|
3386
3452
|
#
|
3387
3453
|
# There are several phases to a task execution. For more information,
|
3388
3454
|
# see [Task execution statuses][1].
|
@@ -3402,13 +3468,13 @@ module Aws::DataSync
|
|
3402
3468
|
# start.
|
3403
3469
|
#
|
3404
3470
|
# @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.
|
3471
|
+
# Indicates how your transfer task is configured. These options include
|
3472
|
+
# how DataSync handles files, objects, and their associated metadata
|
3473
|
+
# during your transfer. You also can specify how to verify data
|
3474
|
+
# integrity, set bandwidth limits for your task, among other options.
|
3409
3475
|
#
|
3410
|
-
# Each
|
3411
|
-
#
|
3476
|
+
# Each option has a default value. Unless you need to, you don't have
|
3477
|
+
# to configure any of these options before starting your task.
|
3412
3478
|
#
|
3413
3479
|
# @option params [Array<Types::FilterRule>] :includes
|
3414
3480
|
# Specifies a list of filter rules that determines which files to
|
@@ -3430,6 +3496,10 @@ module Aws::DataSync
|
|
3430
3496
|
# *Tags* are key-value pairs that help you manage, filter, and search
|
3431
3497
|
# for your DataSync resources.
|
3432
3498
|
#
|
3499
|
+
# @option params [Types::TaskReportConfig] :task_report_config
|
3500
|
+
# Specifies how you want to configure a task report, which provides
|
3501
|
+
# detailed information about for your DataSync transfer.
|
3502
|
+
#
|
3433
3503
|
# @return [Types::StartTaskExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3434
3504
|
#
|
3435
3505
|
# * {Types::StartTaskExecutionResponse#task_execution_arn #task_execution_arn} => String
|
@@ -3473,6 +3543,32 @@ module Aws::DataSync
|
|
3473
3543
|
# value: "TagValue",
|
3474
3544
|
# },
|
3475
3545
|
# ],
|
3546
|
+
# task_report_config: {
|
3547
|
+
# destination: {
|
3548
|
+
# s3: {
|
3549
|
+
# subdirectory: "S3Subdirectory",
|
3550
|
+
# s3_bucket_arn: "S3BucketArn", # required
|
3551
|
+
# bucket_access_role_arn: "IamRoleArn", # required
|
3552
|
+
# },
|
3553
|
+
# },
|
3554
|
+
# output_type: "SUMMARY_ONLY", # accepts SUMMARY_ONLY, STANDARD
|
3555
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
3556
|
+
# object_version_ids: "INCLUDE", # accepts INCLUDE, NONE
|
3557
|
+
# overrides: {
|
3558
|
+
# transferred: {
|
3559
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
3560
|
+
# },
|
3561
|
+
# verified: {
|
3562
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
3563
|
+
# },
|
3564
|
+
# deleted: {
|
3565
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
3566
|
+
# },
|
3567
|
+
# skipped: {
|
3568
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
3569
|
+
# },
|
3570
|
+
# },
|
3571
|
+
# },
|
3476
3572
|
# })
|
3477
3573
|
#
|
3478
3574
|
# @example Response structure
|
@@ -4079,20 +4175,20 @@ module Aws::DataSync
|
|
4079
4175
|
req.send_request(options)
|
4080
4176
|
end
|
4081
4177
|
|
4082
|
-
# Updates the
|
4178
|
+
# Updates the configuration of a DataSync transfer task.
|
4083
4179
|
#
|
4084
4180
|
# @option params [required, String] :task_arn
|
4085
4181
|
# The Amazon Resource Name (ARN) of the resource name of the task to
|
4086
4182
|
# update.
|
4087
4183
|
#
|
4088
4184
|
# @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.
|
4185
|
+
# Indicates how your transfer task is configured. These options include
|
4186
|
+
# how DataSync handles files, objects, and their associated metadata
|
4187
|
+
# during your transfer. You also can specify how to verify data
|
4188
|
+
# integrity, set bandwidth limits for your task, among other options.
|
4093
4189
|
#
|
4094
|
-
# Each
|
4095
|
-
#
|
4190
|
+
# Each option has a default value. Unless you need to, you don't have
|
4191
|
+
# to configure any of these options before starting your task.
|
4096
4192
|
#
|
4097
4193
|
# @option params [Array<Types::FilterRule>] :excludes
|
4098
4194
|
# Specifies a list of filter rules that exclude specific data during
|
@@ -4131,6 +4227,10 @@ module Aws::DataSync
|
|
4131
4227
|
#
|
4132
4228
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
4133
4229
|
#
|
4230
|
+
# @option params [Types::TaskReportConfig] :task_report_config
|
4231
|
+
# Specifies how you want to configure a task report, which provides
|
4232
|
+
# detailed information about for your DataSync transfer.
|
4233
|
+
#
|
4134
4234
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4135
4235
|
#
|
4136
4236
|
# @example Request syntax with placeholder values
|
@@ -4171,6 +4271,32 @@ module Aws::DataSync
|
|
4171
4271
|
# value: "FilterValue",
|
4172
4272
|
# },
|
4173
4273
|
# ],
|
4274
|
+
# task_report_config: {
|
4275
|
+
# destination: {
|
4276
|
+
# s3: {
|
4277
|
+
# subdirectory: "S3Subdirectory",
|
4278
|
+
# s3_bucket_arn: "S3BucketArn", # required
|
4279
|
+
# bucket_access_role_arn: "IamRoleArn", # required
|
4280
|
+
# },
|
4281
|
+
# },
|
4282
|
+
# output_type: "SUMMARY_ONLY", # accepts SUMMARY_ONLY, STANDARD
|
4283
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
4284
|
+
# object_version_ids: "INCLUDE", # accepts INCLUDE, NONE
|
4285
|
+
# overrides: {
|
4286
|
+
# transferred: {
|
4287
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
4288
|
+
# },
|
4289
|
+
# verified: {
|
4290
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
4291
|
+
# },
|
4292
|
+
# deleted: {
|
4293
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
4294
|
+
# },
|
4295
|
+
# skipped: {
|
4296
|
+
# report_level: "ERRORS_ONLY", # accepts ERRORS_ONLY, SUCCESSES_AND_ERRORS
|
4297
|
+
# },
|
4298
|
+
# },
|
4299
|
+
# },
|
4174
4300
|
# })
|
4175
4301
|
#
|
4176
4302
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTask AWS API Documentation
|
@@ -4182,11 +4308,11 @@ module Aws::DataSync
|
|
4182
4308
|
req.send_request(options)
|
4183
4309
|
end
|
4184
4310
|
|
4185
|
-
#
|
4311
|
+
# Updates the configuration of a running DataSync task execution.
|
4186
4312
|
#
|
4187
4313
|
# <note markdown="1"> Currently, the only `Option` that you can modify with
|
4188
4314
|
# `UpdateTaskExecution` is ` BytesPerSecond `, which throttles bandwidth
|
4189
|
-
# for a running or queued task.
|
4315
|
+
# for a running or queued task execution.
|
4190
4316
|
#
|
4191
4317
|
# </note>
|
4192
4318
|
#
|
@@ -4195,13 +4321,13 @@ module Aws::DataSync
|
|
4195
4321
|
# you're updating.
|
4196
4322
|
#
|
4197
4323
|
# @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.
|
4324
|
+
# Indicates how your transfer task is configured. These options include
|
4325
|
+
# how DataSync handles files, objects, and their associated metadata
|
4326
|
+
# during your transfer. You also can specify how to verify data
|
4327
|
+
# integrity, set bandwidth limits for your task, among other options.
|
4202
4328
|
#
|
4203
|
-
# Each
|
4204
|
-
#
|
4329
|
+
# Each option has a default value. Unless you need to, you don't have
|
4330
|
+
# to configure any of these options before starting your task.
|
4205
4331
|
#
|
4206
4332
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4207
4333
|
#
|
@@ -4250,7 +4376,7 @@ module Aws::DataSync
|
|
4250
4376
|
params: params,
|
4251
4377
|
config: config)
|
4252
4378
|
context[:gem_name] = 'aws-sdk-datasync'
|
4253
|
-
context[:gem_version] = '1.
|
4379
|
+
context[:gem_version] = '1.65.0'
|
4254
4380
|
Seahorse::Client::Request.new(handlers, context)
|
4255
4381
|
end
|
4256
4382
|
|
@@ -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,175 @@ 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. 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
|
+
|
4380
4612
|
# Information provided by DataSync Discovery about the resources in your
|
4381
4613
|
# on-premises storage system.
|
4382
4614
|
#
|
@@ -4573,14 +4805,14 @@ module Aws::DataSync
|
|
4573
4805
|
# @return [String]
|
4574
4806
|
#
|
4575
4807
|
# @!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.
|
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.
|
4584
4816
|
# @return [Types::Options]
|
4585
4817
|
#
|
4586
4818
|
# @!attribute [rw] includes
|
@@ -4606,6 +4838,11 @@ module Aws::DataSync
|
|
4606
4838
|
# for your DataSync resources.
|
4607
4839
|
# @return [Array<Types::TagListEntry>]
|
4608
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
|
+
#
|
4609
4846
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartTaskExecutionRequest AWS API Documentation
|
4610
4847
|
#
|
4611
4848
|
class StartTaskExecutionRequest < Struct.new(
|
@@ -4613,7 +4850,8 @@ module Aws::DataSync
|
|
4613
4850
|
:override_options,
|
4614
4851
|
:includes,
|
4615
4852
|
:excludes,
|
4616
|
-
:tags
|
4853
|
+
:tags,
|
4854
|
+
:task_report_config)
|
4617
4855
|
SENSITIVE = []
|
4618
4856
|
include Aws::Structure
|
4619
4857
|
end
|
@@ -4872,6 +5110,79 @@ module Aws::DataSync
|
|
4872
5110
|
include Aws::Structure
|
4873
5111
|
end
|
4874
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
|
+
|
4875
5186
|
# Specifies the schedule you want your task to use for repeated
|
4876
5187
|
# executions. For more information, see [Schedule Expressions for
|
4877
5188
|
# Rules][1].
|
@@ -5399,14 +5710,14 @@ module Aws::DataSync
|
|
5399
5710
|
# @return [String]
|
5400
5711
|
#
|
5401
5712
|
# @!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.
|
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.
|
5410
5721
|
# @return [Types::Options]
|
5411
5722
|
#
|
5412
5723
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecutionRequest AWS API Documentation
|
@@ -5430,14 +5741,14 @@ module Aws::DataSync
|
|
5430
5741
|
# @return [String]
|
5431
5742
|
#
|
5432
5743
|
# @!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.
|
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.
|
5441
5752
|
# @return [Types::Options]
|
5442
5753
|
#
|
5443
5754
|
# @!attribute [rw] excludes
|
@@ -5482,6 +5793,11 @@ module Aws::DataSync
|
|
5482
5793
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
5483
5794
|
# @return [Array<Types::FilterRule>]
|
5484
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
|
+
#
|
5485
5801
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskRequest AWS API Documentation
|
5486
5802
|
#
|
5487
5803
|
class UpdateTaskRequest < Struct.new(
|
@@ -5491,7 +5807,8 @@ module Aws::DataSync
|
|
5491
5807
|
:schedule,
|
5492
5808
|
:name,
|
5493
5809
|
:cloud_watch_log_group_arn,
|
5494
|
-
:includes
|
5810
|
+
:includes,
|
5811
|
+
:task_report_config)
|
5495
5812
|
SENSITIVE = []
|
5496
5813
|
include Aws::Structure
|
5497
5814
|
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.65.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-08-
|
11
|
+
date: 2023-08-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|