aws-sdk-datasync 1.72.0 → 1.74.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.
@@ -674,8 +674,9 @@ module Aws::DataSync
674
674
  # @return [Array<Types::TagListEntry>]
675
675
  #
676
676
  # @!attribute [rw] user
677
- # Specifies the user who has the permissions to access files, folders,
678
- # and metadata in your file system.
677
+ # Specifies the user with the permissions to mount and access the
678
+ # files, folders, and file metadata in your FSx for Windows File
679
+ # Server file system.
679
680
  #
680
681
  # For information about choosing a user with the right level of access
681
682
  # for your transfer, see [required permissions][1] for FSx for Windows
@@ -687,31 +688,18 @@ module Aws::DataSync
687
688
  # @return [String]
688
689
  #
689
690
  # @!attribute [rw] domain
690
- # Specifies the name of the Windows domain that the FSx for Windows
691
- # File Server belongs to.
691
+ # Specifies the name of the Microsoft Active Directory domain that the
692
+ # FSx for Windows File Server file system belongs to.
692
693
  #
693
- # If you have multiple domains in your environment, configuring this
694
- # parameter makes sure that DataSync connects to the right file
695
- # server.
696
- #
697
- # For more information, see [required permissions][1] for FSx for
698
- # Windows File Server locations.
699
- #
700
- #
701
- #
702
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions
694
+ # If you have multiple Active Directory domains in your environment,
695
+ # configuring this parameter makes sure that DataSync connects to the
696
+ # right file system.
703
697
  # @return [String]
704
698
  #
705
699
  # @!attribute [rw] password
706
- # Specifies the password of the user who has the permissions to access
707
- # files and folders in the file system.
708
- #
709
- # For more information, see [required permissions][1] for FSx for
710
- # Windows File Server locations.
711
- #
712
- #
713
- #
714
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions
700
+ # Specifies the password of the user with the permissions to mount and
701
+ # access the files, folders, and file metadata in your FSx for Windows
702
+ # File Server file system.
715
703
  # @return [String]
716
704
  #
717
705
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxWindowsRequest AWS API Documentation
@@ -1048,49 +1036,73 @@ module Aws::DataSync
1048
1036
  # CreateLocationS3Request
1049
1037
  #
1050
1038
  # @!attribute [rw] subdirectory
1051
- # A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon
1052
- # S3 is used to read data from the S3 source location or write data to
1053
- # the S3 destination.
1039
+ # Specifies a prefix in the S3 bucket that DataSync reads from or
1040
+ # writes to (depending on whether the bucket is a source or
1041
+ # destination location).
1042
+ #
1043
+ # <note markdown="1"> DataSync can't transfer objects with a prefix that begins with a
1044
+ # slash (`/`) or includes `//`, `/./`, or `/../` patterns. For
1045
+ # example:
1046
+ #
1047
+ # * `/photos`
1048
+ #
1049
+ # * `photos//2006/January`
1050
+ #
1051
+ # * `photos/./2006/February`
1052
+ #
1053
+ # * `photos/../2006/March`
1054
+ #
1055
+ # </note>
1054
1056
  # @return [String]
1055
1057
  #
1056
1058
  # @!attribute [rw] s3_bucket_arn
1057
- # The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web
1058
- # Services Outpost, this must be an access point ARN.
1059
+ # Specifies the ARN of the S3 bucket that you want to use as a
1060
+ # location. (When creating your DataSync task later, you specify
1061
+ # whether this location is a transfer source or destination.)
1062
+ #
1063
+ # If your S3 bucket is located on an Outposts resource, you must
1064
+ # specify an Amazon S3 access point. For more information, see
1065
+ # [Managing data access with Amazon S3 access points][1] in the
1066
+ # *Amazon S3 User Guide*.
1067
+ #
1068
+ #
1069
+ #
1070
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
1059
1071
  # @return [String]
1060
1072
  #
1061
1073
  # @!attribute [rw] s3_storage_class
1062
- # The Amazon S3 storage class that you want to store your files in
1063
- # when this location is used as a task destination. For buckets in
1064
- # Amazon Web Services Regions, the storage class defaults to Standard.
1065
- # For buckets on Outposts, the storage class defaults to Amazon Web
1066
- # Services S3 Outposts.
1074
+ # Specifies the storage class that you want your objects to use when
1075
+ # Amazon S3 is a transfer destination.
1076
+ #
1077
+ # For buckets in Amazon Web Services Regions, the storage class
1078
+ # defaults to `STANDARD`. For buckets on Outposts, the storage class
1079
+ # defaults to `OUTPOSTS`.
1067
1080
  #
1068
- # For more information about S3 storage classes, see [Amazon S3
1069
- # Storage Classes][1]. Some storage classes have behaviors that can
1070
- # affect your S3 storage cost. For detailed information, see
1071
- # [Considerations when working with S3 storage classes in
1072
- # DataSync][2].
1081
+ # For more information, see [Storage class considerations with Amazon
1082
+ # S3 transfers][1].
1073
1083
  #
1074
1084
  #
1075
1085
  #
1076
- # [1]: http://aws.amazon.com/s3/storage-classes/
1077
- # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
1086
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
1078
1087
  # @return [String]
1079
1088
  #
1080
1089
  # @!attribute [rw] s3_config
1081
- # The Amazon Resource Name (ARN) of the Identity and Access Management
1082
- # (IAM) role used to access an Amazon S3 bucket.
1090
+ # Specifies the Amazon Resource Name (ARN) of the Identity and Access
1091
+ # Management (IAM) role that DataSync uses to access your S3 bucket.
1092
+ #
1093
+ # For more information, see [Accessing S3 buckets][1].
1094
+ #
1083
1095
  #
1084
- # For detailed information about using such a role, see Creating a
1085
- # Location for Amazon S3 in the *DataSync User Guide*.
1096
+ #
1097
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access
1086
1098
  # @return [Types::S3Config]
1087
1099
  #
1088
1100
  # @!attribute [rw] agent_arns
1089
- # If you're using DataSync on an Amazon Web Services Outpost, specify
1090
- # the Amazon Resource Names (ARNs) of the DataSync agents deployed on
1091
- # your Outpost. For more information about launching a DataSync agent
1092
- # on an Amazon Web Services Outpost, see [Deploy your DataSync agent
1093
- # on Outposts][1].
1101
+ # (Amazon S3 on Outposts only) Specifies the Amazon Resource Name
1102
+ # (ARN) of the DataSync agent on your Outpost.
1103
+ #
1104
+ # For more information, see [Deploy your DataSync agent on
1105
+ # Outposts][1].
1094
1106
  #
1095
1107
  #
1096
1108
  #
@@ -1098,9 +1110,9 @@ module Aws::DataSync
1098
1110
  # @return [Array<String>]
1099
1111
  #
1100
1112
  # @!attribute [rw] tags
1101
- # The key-value pair that represents the tag that you want to add to
1102
- # the location. The value can be an empty string. We recommend using
1103
- # tags to name your resources.
1113
+ # Specifies labels that help you categorize, filter, and search for
1114
+ # your Amazon Web Services resources. We recommend creating at least a
1115
+ # name tag for your transfer location.
1104
1116
  # @return [Array<Types::TagListEntry>]
1105
1117
  #
1106
1118
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationS3Request AWS API Documentation
@@ -1119,8 +1131,7 @@ module Aws::DataSync
1119
1131
  # CreateLocationS3Response
1120
1132
  #
1121
1133
  # @!attribute [rw] location_arn
1122
- # The Amazon Resource Name (ARN) of the source Amazon S3 bucket
1123
- # location that is created.
1134
+ # The ARN of the S3 location that you created.
1124
1135
  # @return [String]
1125
1136
  #
1126
1137
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationS3Response AWS API Documentation
@@ -1140,9 +1151,9 @@ module Aws::DataSync
1140
1151
  # `/path/to/subdirectory`). Make sure that other SMB clients in your
1141
1152
  # network can also mount this path.
1142
1153
  #
1143
- # To copy all data in the specified subdirectory, DataSync must be
1144
- # able to mount the SMB share and access all of its data. For more
1145
- # information, see [required permissions][1] for SMB locations.
1154
+ # To copy all data in the subdirectory, DataSync must be able to mount
1155
+ # the SMB share and access all of its data. For more information, see
1156
+ # [required permissions][1] for SMB locations.
1146
1157
  #
1147
1158
  #
1148
1159
  #
@@ -1159,9 +1170,8 @@ module Aws::DataSync
1159
1170
  # @return [String]
1160
1171
  #
1161
1172
  # @!attribute [rw] user
1162
- # Specifies the user name that can mount your SMB file server and has
1163
- # permission to access the files and folders involved in your
1164
- # transfer.
1173
+ # Specifies the user that can mount and access the files, folders, and
1174
+ # file metadata in your SMB file server.
1165
1175
  #
1166
1176
  # For information about choosing a user with the right level of access
1167
1177
  # for your transfer, see [required permissions][1] for SMB locations.
@@ -1172,19 +1182,12 @@ module Aws::DataSync
1172
1182
  # @return [String]
1173
1183
  #
1174
1184
  # @!attribute [rw] domain
1175
- # Specifies the Windows domain name that your SMB file server belongs
1176
- # to.
1177
- #
1178
- # If you have multiple domains in your environment, configuring this
1179
- # parameter makes sure that DataSync connects to the right file
1180
- # server.
1181
- #
1182
- # For more information, see [required permissions][1] for SMB
1183
- # locations.
1184
- #
1185
+ # Specifies the name of the Active Directory domain that your SMB file
1186
+ # server belongs to.
1185
1187
  #
1186
- #
1187
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
1188
+ # If you have multiple Active Directory domains in your environment,
1189
+ # configuring this parameter makes sure that DataSync connects to the
1190
+ # right file server.
1188
1191
  # @return [String]
1189
1192
  #
1190
1193
  # @!attribute [rw] password
@@ -1249,41 +1252,32 @@ module Aws::DataSync
1249
1252
  # CreateTaskRequest
1250
1253
  #
1251
1254
  # @!attribute [rw] source_location_arn
1252
- # The Amazon Resource Name (ARN) of the source location for the task.
1255
+ # Specifies the ARN of your transfer's source location.
1253
1256
  # @return [String]
1254
1257
  #
1255
1258
  # @!attribute [rw] destination_location_arn
1256
- # The Amazon Resource Name (ARN) of an Amazon Web Services storage
1257
- # resource's location.
1259
+ # Specifies the ARN of your transfer's destination location.
1258
1260
  # @return [String]
1259
1261
  #
1260
1262
  # @!attribute [rw] cloud_watch_log_group_arn
1261
- # The Amazon Resource Name (ARN) of the Amazon CloudWatch log group
1262
- # that is used to monitor and log events in the task.
1263
+ # Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log
1264
+ # group for monitoring your task.
1263
1265
  # @return [String]
1264
1266
  #
1265
1267
  # @!attribute [rw] name
1266
- # The name of a task. This value is a text reference that is used to
1267
- # identify the task in the console.
1268
+ # Specifies the name of your task.
1268
1269
  # @return [String]
1269
1270
  #
1270
1271
  # @!attribute [rw] options
1271
- # Specifies the configuration options for a task. Some options include
1272
- # preserving file or object metadata and verifying data integrity.
1273
- #
1274
- # You can also override these options before starting an individual
1275
- # run of a task (also known as a *task execution*). For more
1276
- # information, see [StartTaskExecution][1].
1277
- #
1278
- #
1279
- #
1280
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
1272
+ # Specifies your task's settings, such as preserving file metadata,
1273
+ # verifying data integrity, among other options.
1281
1274
  # @return [Types::Options]
1282
1275
  #
1283
1276
  # @!attribute [rw] excludes
1284
- # Specifies a list of filter rules that exclude specific data during
1285
- # your transfer. For more information and examples, see [Filtering
1286
- # data transferred by DataSync][1].
1277
+ # Specifies exclude filters that define the files, objects, and
1278
+ # folders in your source location that you don't want DataSync to
1279
+ # transfer. For more information and examples, see [Specifying what
1280
+ # DataSync transfers by using filters][1].
1287
1281
  #
1288
1282
  #
1289
1283
  #
@@ -1291,9 +1285,8 @@ module Aws::DataSync
1291
1285
  # @return [Array<Types::FilterRule>]
1292
1286
  #
1293
1287
  # @!attribute [rw] schedule
1294
- # Specifies a schedule used to periodically transfer files from a
1295
- # source to a destination location. The schedule should be specified
1296
- # in UTC time. For more information, see [Scheduling your task][1].
1288
+ # Specifies a schedule for when you want your task to run. For more
1289
+ # information, see [Scheduling your task][1].
1297
1290
  #
1298
1291
  #
1299
1292
  #
@@ -1301,26 +1294,55 @@ module Aws::DataSync
1301
1294
  # @return [Types::TaskSchedule]
1302
1295
  #
1303
1296
  # @!attribute [rw] tags
1304
- # Specifies the tags that you want to apply to the Amazon Resource
1305
- # Name (ARN) representing the task.
1297
+ # Specifies the tags that you want to apply to your task.
1306
1298
  #
1307
1299
  # *Tags* are key-value pairs that help you manage, filter, and search
1308
1300
  # for your DataSync resources.
1309
1301
  # @return [Array<Types::TagListEntry>]
1310
1302
  #
1311
1303
  # @!attribute [rw] includes
1312
- # Specifies a list of filter rules that include specific data during
1313
- # your transfer. For more information and examples, see [Filtering
1314
- # data transferred by DataSync][1].
1304
+ # Specifies include filters define the files, objects, and folders in
1305
+ # your source location that you want DataSync to transfer. For more
1306
+ # information and examples, see [Specifying what DataSync transfers by
1307
+ # using filters][1].
1315
1308
  #
1316
1309
  #
1317
1310
  #
1318
1311
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
1319
1312
  # @return [Array<Types::FilterRule>]
1320
1313
  #
1314
+ # @!attribute [rw] manifest_config
1315
+ # Configures a manifest, which is a list of files or objects that you
1316
+ # want DataSync to transfer. For more information and configuration
1317
+ # examples, see [Specifying what DataSync transfers by using a
1318
+ # manifest][1].
1319
+ #
1320
+ # When using this parameter, your caller identity (the role that
1321
+ # you're using DataSync with) must have the `iam:PassRole`
1322
+ # permission. The [AWSDataSyncFullAccess][2] policy includes this
1323
+ # permission.
1324
+ #
1325
+ #
1326
+ #
1327
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
1328
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
1329
+ # @return [Types::ManifestConfig]
1330
+ #
1321
1331
  # @!attribute [rw] task_report_config
1322
1332
  # Specifies how you want to configure a task report, which provides
1323
- # detailed information about for your DataSync transfer.
1333
+ # detailed information about your DataSync transfer. For more
1334
+ # information, see [Monitoring your DataSync transfers with task
1335
+ # reports][1].
1336
+ #
1337
+ # When using this parameter, your caller identity (the role that
1338
+ # you're using DataSync with) must have the `iam:PassRole`
1339
+ # permission. The [AWSDataSyncFullAccess][2] policy includes this
1340
+ # permission.
1341
+ #
1342
+ #
1343
+ #
1344
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
1345
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
1324
1346
  # @return [Types::TaskReportConfig]
1325
1347
  #
1326
1348
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTaskRequest AWS API Documentation
@@ -1335,6 +1357,7 @@ module Aws::DataSync
1335
1357
  :schedule,
1336
1358
  :tags,
1337
1359
  :includes,
1360
+ :manifest_config,
1338
1361
  :task_report_config)
1339
1362
  SENSITIVE = []
1340
1363
  include Aws::Structure
@@ -1876,8 +1899,8 @@ module Aws::DataSync
1876
1899
  end
1877
1900
 
1878
1901
  # @!attribute [rw] location_arn
1879
- # The Amazon Resource Name (ARN) of the FSx for Windows File Server
1880
- # location to describe.
1902
+ # Specifies the Amazon Resource Name (ARN) of the FSx for Windows File
1903
+ # Server location.
1881
1904
  # @return [String]
1882
1905
  #
1883
1906
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxWindowsRequest AWS API Documentation
@@ -1889,18 +1912,17 @@ module Aws::DataSync
1889
1912
  end
1890
1913
 
1891
1914
  # @!attribute [rw] location_arn
1892
- # The Amazon Resource Name (ARN) of the FSx for Windows File Server
1893
- # location that was described.
1915
+ # The ARN of the FSx for Windows File Server location.
1894
1916
  # @return [String]
1895
1917
  #
1896
1918
  # @!attribute [rw] location_uri
1897
- # The URL of the FSx for Windows File Server location that was
1898
- # described.
1919
+ # The uniform resource identifier (URI) of the FSx for Windows File
1920
+ # Server location.
1899
1921
  # @return [String]
1900
1922
  #
1901
1923
  # @!attribute [rw] security_group_arns
1902
- # The Amazon Resource Names (ARNs) of the security groups that are
1903
- # configured for the FSx for Windows File Server file system.
1924
+ # The ARNs of the security groups that are configured for the FSx for
1925
+ # Windows File Server file system.
1904
1926
  # @return [Array<String>]
1905
1927
  #
1906
1928
  # @!attribute [rw] creation_time
@@ -1908,13 +1930,13 @@ module Aws::DataSync
1908
1930
  # @return [Time]
1909
1931
  #
1910
1932
  # @!attribute [rw] user
1911
- # The user who has the permissions to access files and folders in the
1912
- # FSx for Windows File Server file system.
1933
+ # The user with the permissions to mount and access the FSx for
1934
+ # Windows File Server file system.
1913
1935
  # @return [String]
1914
1936
  #
1915
1937
  # @!attribute [rw] domain
1916
- # The name of the Windows domain that the FSx for Windows File Server
1917
- # belongs to.
1938
+ # The name of the Microsoft Active Directory domain that the FSx for
1939
+ # Windows File Server file system belongs to.
1918
1940
  # @return [String]
1919
1941
  #
1920
1942
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxWindowsResponse AWS API Documentation
@@ -1931,8 +1953,7 @@ module Aws::DataSync
1931
1953
  end
1932
1954
 
1933
1955
  # @!attribute [rw] location_arn
1934
- # The Amazon Resource Name (ARN) of the HDFS cluster location to
1935
- # describe.
1956
+ # Specifies the Amazon Resource Name (ARN) of the HDFS location.
1936
1957
  # @return [String]
1937
1958
  #
1938
1959
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationHdfsRequest AWS API Documentation
@@ -1944,15 +1965,15 @@ module Aws::DataSync
1944
1965
  end
1945
1966
 
1946
1967
  # @!attribute [rw] location_arn
1947
- # The ARN of the HDFS cluster location.
1968
+ # The ARN of the HDFS location.
1948
1969
  # @return [String]
1949
1970
  #
1950
1971
  # @!attribute [rw] location_uri
1951
- # The URI of the HDFS cluster location.
1972
+ # The URI of the HDFS location.
1952
1973
  # @return [String]
1953
1974
  #
1954
1975
  # @!attribute [rw] name_nodes
1955
- # The NameNode that manage the HDFS namespace.
1976
+ # The NameNode that manages the HDFS namespace.
1956
1977
  # @return [Array<Types::HdfsNameNode>]
1957
1978
  #
1958
1979
  # @!attribute [rw] block_size
@@ -1969,9 +1990,9 @@ module Aws::DataSync
1969
1990
  # @return [String]
1970
1991
  #
1971
1992
  # @!attribute [rw] qop_configuration
1972
- # The Quality of Protection (QOP) configuration specifies the Remote
1973
- # Procedure Call (RPC) and data transfer protection settings
1974
- # configured on the Hadoop Distributed File System (HDFS) cluster.
1993
+ # The Quality of Protection (QOP) configuration, which specifies the
1994
+ # Remote Procedure Call (RPC) and data transfer protection settings
1995
+ # configured on the HDFS cluster.
1975
1996
  # @return [Types::QopConfiguration]
1976
1997
  #
1977
1998
  # @!attribute [rw] authentication_type
@@ -1980,9 +2001,9 @@ module Aws::DataSync
1980
2001
  # @return [String]
1981
2002
  #
1982
2003
  # @!attribute [rw] simple_user
1983
- # The user name used to identify the client on the host operating
1984
- # system. This parameter is used if the `AuthenticationType` is
1985
- # defined as `SIMPLE`.
2004
+ # The user name to identify the client on the host operating system.
2005
+ # This parameter is used if the `AuthenticationType` is defined as
2006
+ # `SIMPLE`.
1986
2007
  # @return [String]
1987
2008
  #
1988
2009
  # @!attribute [rw] kerberos_principal
@@ -1992,7 +2013,8 @@ module Aws::DataSync
1992
2013
  # @return [String]
1993
2014
  #
1994
2015
  # @!attribute [rw] agent_arns
1995
- # The ARNs of the agents that are used to connect to the HDFS cluster.
2016
+ # The ARNs of the DataSync agents that can connect with your HDFS
2017
+ # cluster.
1996
2018
  # @return [Array<String>]
1997
2019
  #
1998
2020
  # @!attribute [rw] creation_time
@@ -2040,7 +2062,7 @@ module Aws::DataSync
2040
2062
  # @return [String]
2041
2063
  #
2042
2064
  # @!attribute [rw] location_uri
2043
- # The URL of the NFS location.
2065
+ # The URI of the NFS location.
2044
2066
  # @return [String]
2045
2067
  #
2046
2068
  # @!attribute [rw] on_prem_config
@@ -2071,8 +2093,8 @@ module Aws::DataSync
2071
2093
  # DescribeLocationObjectStorageRequest
2072
2094
  #
2073
2095
  # @!attribute [rw] location_arn
2074
- # The Amazon Resource Name (ARN) of the object storage system location
2075
- # that you want information about.
2096
+ # Specifies the Amazon Resource Name (ARN) of the object storage
2097
+ # system location.
2076
2098
  # @return [String]
2077
2099
  #
2078
2100
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationObjectStorageRequest AWS API Documentation
@@ -2090,7 +2112,7 @@ module Aws::DataSync
2090
2112
  # @return [String]
2091
2113
  #
2092
2114
  # @!attribute [rw] location_uri
2093
- # The URL of the object storage system location.
2115
+ # The URI of the object storage system location.
2094
2116
  # @return [String]
2095
2117
  #
2096
2118
  # @!attribute [rw] access_key
@@ -2108,8 +2130,8 @@ module Aws::DataSync
2108
2130
  # @return [String]
2109
2131
  #
2110
2132
  # @!attribute [rw] agent_arns
2111
- # The ARNs of the DataSync agents that can securely connect with your
2112
- # location.
2133
+ # The ARNs of the DataSync agents that can connect with your object
2134
+ # storage system.
2113
2135
  # @return [Array<String>]
2114
2136
  #
2115
2137
  # @!attribute [rw] creation_time
@@ -2139,8 +2161,7 @@ module Aws::DataSync
2139
2161
  # DescribeLocationS3Request
2140
2162
  #
2141
2163
  # @!attribute [rw] location_arn
2142
- # The Amazon Resource Name (ARN) of the Amazon S3 bucket location to
2143
- # describe.
2164
+ # Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.
2144
2165
  # @return [String]
2145
2166
  #
2146
2167
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationS3Request AWS API Documentation
@@ -2154,8 +2175,7 @@ module Aws::DataSync
2154
2175
  # DescribeLocationS3Response
2155
2176
  #
2156
2177
  # @!attribute [rw] location_arn
2157
- # The Amazon Resource Name (ARN) of the Amazon S3 bucket or access
2158
- # point.
2178
+ # The ARN of the Amazon S3 location.
2159
2179
  # @return [String]
2160
2180
  #
2161
2181
  # @!attribute [rw] location_uri
@@ -2163,32 +2183,34 @@ module Aws::DataSync
2163
2183
  # @return [String]
2164
2184
  #
2165
2185
  # @!attribute [rw] s3_storage_class
2166
- # The Amazon S3 storage class that you chose to store your files in
2167
- # when this location is used as a task destination. For more
2168
- # information about S3 storage classes, see [Amazon S3 Storage
2169
- # Classes][1]. Some storage classes have behaviors that can affect
2170
- # your S3 storage cost. For detailed information, see [Considerations
2171
- # when working with S3 storage classes in DataSync][2].
2186
+ # When Amazon S3 is a destination location, this is the storage class
2187
+ # that you chose for your objects.
2188
+ #
2189
+ # Some storage classes have behaviors that can affect your Amazon S3
2190
+ # storage costs. For more information, see [Storage class
2191
+ # considerations with Amazon S3 transfers][1].
2172
2192
  #
2173
2193
  #
2174
2194
  #
2175
- # [1]: http://aws.amazon.com/s3/storage-classes/
2176
- # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
2195
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
2177
2196
  # @return [String]
2178
2197
  #
2179
2198
  # @!attribute [rw] s3_config
2180
- # The Amazon Resource Name (ARN) of the Identity and Access Management
2181
- # (IAM) role used to access an Amazon S3 bucket.
2199
+ # Specifies the Amazon Resource Name (ARN) of the Identity and Access
2200
+ # Management (IAM) role that DataSync uses to access your S3 bucket.
2201
+ #
2202
+ # For more information, see [Accessing S3 buckets][1].
2203
+ #
2182
2204
  #
2183
- # For detailed information about using such a role, see Creating a
2184
- # Location for Amazon S3 in the *DataSync User Guide*.
2205
+ #
2206
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access
2185
2207
  # @return [Types::S3Config]
2186
2208
  #
2187
2209
  # @!attribute [rw] agent_arns
2188
- # If you are using DataSync on an Amazon Web Services Outpost, the
2189
- # Amazon Resource Name (ARNs) of the EC2 agents deployed on your
2190
- # Outpost. For more information about launching a DataSync agent on an
2191
- # Amazon Web Services Outpost, see [Deploy your DataSync agent on
2210
+ # The ARNs of the DataSync agents deployed on your Outpost when using
2211
+ # working with Amazon S3 on Outposts.
2212
+ #
2213
+ # For more information, see [Deploy your DataSync agent on
2192
2214
  # Outposts][1].
2193
2215
  #
2194
2216
  #
@@ -2197,7 +2219,7 @@ module Aws::DataSync
2197
2219
  # @return [Array<String>]
2198
2220
  #
2199
2221
  # @!attribute [rw] creation_time
2200
- # The time that the Amazon S3 bucket location was created.
2222
+ # The time that the Amazon S3 location was created.
2201
2223
  # @return [Time]
2202
2224
  #
2203
2225
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationS3Response AWS API Documentation
@@ -2216,7 +2238,8 @@ module Aws::DataSync
2216
2238
  # DescribeLocationSmbRequest
2217
2239
  #
2218
2240
  # @!attribute [rw] location_arn
2219
- # The Amazon Resource Name (ARN) of the SMB location to describe.
2241
+ # Specifies the Amazon Resource Name (ARN) of the SMB location that
2242
+ # you want information about.
2220
2243
  # @return [String]
2221
2244
  #
2222
2245
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationSmbRequest AWS API Documentation
@@ -2230,31 +2253,30 @@ module Aws::DataSync
2230
2253
  # DescribeLocationSmbResponse
2231
2254
  #
2232
2255
  # @!attribute [rw] location_arn
2233
- # The Amazon Resource Name (ARN) of the SMB location that was
2234
- # described.
2256
+ # The ARN of the SMB location.
2235
2257
  # @return [String]
2236
2258
  #
2237
2259
  # @!attribute [rw] location_uri
2238
- # The URL of the source SMB location that was described.
2260
+ # The URI of the SMB location.
2239
2261
  # @return [String]
2240
2262
  #
2241
2263
  # @!attribute [rw] agent_arns
2242
- # The Amazon Resource Name (ARN) of the source SMB file system
2243
- # location that is created.
2264
+ # The ARNs of the DataSync agents that can connect with your SMB file
2265
+ # server.
2244
2266
  # @return [Array<String>]
2245
2267
  #
2246
2268
  # @!attribute [rw] user
2247
- # The user who can mount the share, has the permissions to access
2248
- # files and folders in the SMB share.
2269
+ # The user that can mount and access the files, folders, and file
2270
+ # metadata in your SMB file server.
2249
2271
  # @return [String]
2250
2272
  #
2251
2273
  # @!attribute [rw] domain
2252
- # The name of the Windows domain that the SMB server belongs to.
2274
+ # The name of the Microsoft Active Directory domain that the SMB file
2275
+ # server belongs to.
2253
2276
  # @return [String]
2254
2277
  #
2255
2278
  # @!attribute [rw] mount_options
2256
- # The mount options that are available for DataSync to use to access
2257
- # an SMB location.
2279
+ # The protocol that DataSync use to access your SMB file.
2258
2280
  # @return [Types::SmbMountOptions]
2259
2281
  #
2260
2282
  # @!attribute [rw] creation_time
@@ -2548,7 +2570,15 @@ module Aws::DataSync
2548
2570
  # options.
2549
2571
  #
2550
2572
  # Each option has a default value. Unless you need to, you don't have
2551
- # to configure any of these options before starting your task.
2573
+ # to configure any option before calling [StartTaskExecution][1].
2574
+ #
2575
+ # You also can override your task options for each task execution. For
2576
+ # example, you might want to adjust the `LogLevel` for an individual
2577
+ # execution.
2578
+ #
2579
+ #
2580
+ #
2581
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
2552
2582
  # @return [Types::Options]
2553
2583
  #
2554
2584
  # @!attribute [rw] excludes
@@ -2571,6 +2601,16 @@ module Aws::DataSync
2571
2601
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
2572
2602
  # @return [Array<Types::FilterRule>]
2573
2603
  #
2604
+ # @!attribute [rw] manifest_config
2605
+ # The configuration of the manifest that lists the files or objects to
2606
+ # transfer. For more information, see [Specifying what DataSync
2607
+ # transfers by using a manifest][1].
2608
+ #
2609
+ #
2610
+ #
2611
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
2612
+ # @return [Types::ManifestConfig]
2613
+ #
2574
2614
  # @!attribute [rw] start_time
2575
2615
  # The time when the task execution started.
2576
2616
  # @return [Time]
@@ -2612,19 +2652,24 @@ module Aws::DataSync
2612
2652
  # number of bytes sent over the network, see `BytesCompressed`.
2613
2653
  # @return [Integer]
2614
2654
  #
2615
- # @!attribute [rw] result
2616
- # The result of the task execution.
2617
- # @return [Types::TaskExecutionResultDetail]
2618
- #
2619
2655
  # @!attribute [rw] bytes_compressed
2620
2656
  # The physical number of bytes transferred over the network after
2621
2657
  # compression was applied. In most cases, this number is less than
2622
2658
  # `BytesTransferred` unless the data isn't compressible.
2623
2659
  # @return [Integer]
2624
2660
  #
2661
+ # @!attribute [rw] result
2662
+ # The result of the task execution.
2663
+ # @return [Types::TaskExecutionResultDetail]
2664
+ #
2625
2665
  # @!attribute [rw] task_report_config
2626
2666
  # The configuration of your task report, which provides detailed
2627
- # information about for your DataSync transfer.
2667
+ # information about for your DataSync transfer. For more information,
2668
+ # see [Creating a task report][1].
2669
+ #
2670
+ #
2671
+ #
2672
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
2628
2673
  # @return [Types::TaskReportConfig]
2629
2674
  #
2630
2675
  # @!attribute [rw] files_deleted
@@ -2686,14 +2731,15 @@ module Aws::DataSync
2686
2731
  :options,
2687
2732
  :excludes,
2688
2733
  :includes,
2734
+ :manifest_config,
2689
2735
  :start_time,
2690
2736
  :estimated_files_to_transfer,
2691
2737
  :estimated_bytes_to_transfer,
2692
2738
  :files_transferred,
2693
2739
  :bytes_written,
2694
2740
  :bytes_transferred,
2695
- :result,
2696
2741
  :bytes_compressed,
2742
+ :result,
2697
2743
  :task_report_config,
2698
2744
  :files_deleted,
2699
2745
  :files_skipped,
@@ -2707,7 +2753,8 @@ module Aws::DataSync
2707
2753
  # DescribeTaskRequest
2708
2754
  #
2709
2755
  # @!attribute [rw] task_arn
2710
- # Specifies the Amazon Resource Name (ARN) of the transfer task.
2756
+ # Specifies the Amazon Resource Name (ARN) of the transfer task that
2757
+ # you want information about.
2711
2758
  # @return [String]
2712
2759
  #
2713
2760
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskRequest AWS API Documentation
@@ -2721,47 +2768,49 @@ module Aws::DataSync
2721
2768
  # DescribeTaskResponse
2722
2769
  #
2723
2770
  # @!attribute [rw] task_arn
2724
- # The Amazon Resource Name (ARN) of the task that was described.
2771
+ # The ARN of your task.
2725
2772
  # @return [String]
2726
2773
  #
2727
2774
  # @!attribute [rw] status
2728
- # The status of the task that was described.
2775
+ # The status of your task. For information about what each status
2776
+ # means, see [Task statuses][1].
2777
+ #
2778
+ #
2729
2779
  #
2730
- # For detailed information about task execution statuses, see
2731
- # Understanding Task Statuses in the *DataSync User Guide*.
2780
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-creation-statuses
2732
2781
  # @return [String]
2733
2782
  #
2734
2783
  # @!attribute [rw] name
2735
- # The name of the task that was described.
2784
+ # The name of your task.
2736
2785
  # @return [String]
2737
2786
  #
2738
2787
  # @!attribute [rw] current_task_execution_arn
2739
- # The Amazon Resource Name (ARN) of the task execution that is
2740
- # transferring files.
2788
+ # The ARN of the most recent task execution.
2741
2789
  # @return [String]
2742
2790
  #
2743
2791
  # @!attribute [rw] source_location_arn
2744
- # The Amazon Resource Name (ARN) of the source file system's
2745
- # location.
2792
+ # The ARN of your transfer's source location.
2746
2793
  # @return [String]
2747
2794
  #
2748
2795
  # @!attribute [rw] destination_location_arn
2749
- # The Amazon Resource Name (ARN) of the Amazon Web Services storage
2750
- # resource's location.
2796
+ # The ARN of your transfer's destination location.
2751
2797
  # @return [String]
2752
2798
  #
2753
2799
  # @!attribute [rw] cloud_watch_log_group_arn
2754
- # The Amazon Resource Name (ARN) of the Amazon CloudWatch log group
2755
- # that was used to monitor and log events in the task.
2800
+ # The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for
2801
+ # monitoring your task.
2802
+ #
2803
+ # For more information, see [Monitoring DataSync with Amazon
2804
+ # CloudWatch][1].
2805
+ #
2756
2806
  #
2757
- # For more information on these groups, see Working with Log Groups
2758
- # and Log Streams in the *Amazon CloudWatch User Guide*.
2807
+ #
2808
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html
2759
2809
  # @return [String]
2760
2810
  #
2761
2811
  # @!attribute [rw] source_network_interface_arns
2762
- # The Amazon Resource Names (ARNs) of the network interfaces created
2763
- # for your source location. For more information, see [Network
2764
- # interface requirements][1].
2812
+ # The ARNs of the [network interfaces][1] that DataSync created for
2813
+ # your source location.
2765
2814
  #
2766
2815
  #
2767
2816
  #
@@ -2769,9 +2818,8 @@ module Aws::DataSync
2769
2818
  # @return [Array<String>]
2770
2819
  #
2771
2820
  # @!attribute [rw] destination_network_interface_arns
2772
- # The Amazon Resource Names (ARNs) of the network interfaces created
2773
- # for your destination location. For more information, see [Network
2774
- # interface requirements][1].
2821
+ # The ARNs of the [network interfaces][1] that DataSync created for
2822
+ # your destination location.
2775
2823
  #
2776
2824
  #
2777
2825
  #
@@ -2779,22 +2827,16 @@ module Aws::DataSync
2779
2827
  # @return [Array<String>]
2780
2828
  #
2781
2829
  # @!attribute [rw] options
2782
- # The configuration options that control the behavior of the
2783
- # `StartTaskExecution` operation. Some options include preserving file
2784
- # or object metadata and verifying data integrity.
2785
- #
2786
- # You can override these options for each task execution. For more
2787
- # information, see [StartTaskExecution][1].
2788
- #
2789
- #
2790
- #
2791
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
2830
+ # The task's settings. For example, what file metadata gets
2831
+ # preserved, how data integrity gets verified at the end of your
2832
+ # transfer, bandwidth limits, among other options.
2792
2833
  # @return [Types::Options]
2793
2834
  #
2794
2835
  # @!attribute [rw] excludes
2795
- # A list of filter rules that exclude specific data during your
2796
- # transfer. For more information and examples, see [Filtering data
2797
- # transferred by DataSync][1].
2836
+ # The exclude filters that define the files, objects, and folders in
2837
+ # your source location that you don't want DataSync to transfer. For
2838
+ # more information and examples, see [Specifying what DataSync
2839
+ # transfers by using filters][1].
2798
2840
  #
2799
2841
  #
2800
2842
  #
@@ -2802,19 +2844,32 @@ module Aws::DataSync
2802
2844
  # @return [Array<Types::FilterRule>]
2803
2845
  #
2804
2846
  # @!attribute [rw] schedule
2805
- # The schedule used to periodically transfer files from a source to a
2806
- # destination location.
2847
+ # The schedule for when you want your task to run. For more
2848
+ # information, see [Scheduling your task][1].
2849
+ #
2850
+ #
2851
+ #
2852
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
2807
2853
  # @return [Types::TaskSchedule]
2808
2854
  #
2809
2855
  # @!attribute [rw] error_code
2810
- # Errors that DataSync encountered during execution of the task. You
2811
- # can use this error code to help troubleshoot issues.
2856
+ # If there's an issue with your task, you can use the error code to
2857
+ # help you troubleshoot the problem. For more information, see
2858
+ # [Troubleshooting issues with DataSync transfers][1].
2859
+ #
2860
+ #
2861
+ #
2862
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html
2812
2863
  # @return [String]
2813
2864
  #
2814
2865
  # @!attribute [rw] error_detail
2815
- # Detailed description of an error that was encountered during the
2816
- # task execution. You can use this information to help troubleshoot
2817
- # issues.
2866
+ # If there's an issue with your task, you can use the error details
2867
+ # to help you troubleshoot the problem. For more information, see
2868
+ # [Troubleshooting issues with DataSync transfers][1].
2869
+ #
2870
+ #
2871
+ #
2872
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html
2818
2873
  # @return [String]
2819
2874
  #
2820
2875
  # @!attribute [rw] creation_time
@@ -2822,24 +2877,44 @@ module Aws::DataSync
2822
2877
  # @return [Time]
2823
2878
  #
2824
2879
  # @!attribute [rw] includes
2825
- # A list of filter rules that include specific data during your
2826
- # transfer. For more information and examples, see [Filtering data
2827
- # transferred by DataSync][1].
2880
+ # The include filters that define the files, objects, and folders in
2881
+ # your source location that you want DataSync to transfer. For more
2882
+ # information and examples, see [Specifying what DataSync transfers by
2883
+ # using filters][1].
2828
2884
  #
2829
2885
  #
2830
2886
  #
2831
2887
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
2832
2888
  # @return [Array<Types::FilterRule>]
2833
2889
  #
2890
+ # @!attribute [rw] manifest_config
2891
+ # The configuration of the manifest that lists the files or objects
2892
+ # that you want DataSync to transfer. For more information, see
2893
+ # [Specifying what DataSync transfers by using a manifest][1].
2894
+ #
2895
+ #
2896
+ #
2897
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
2898
+ # @return [Types::ManifestConfig]
2899
+ #
2834
2900
  # @!attribute [rw] task_report_config
2835
- # The configuration of your task report. For more information, see
2836
- # [Creating a task report][1].
2901
+ # The configuration of your task report, which provides detailed
2902
+ # information about your DataSync transfer. For more information, see
2903
+ # [Monitoring your DataSync transfers with task reports][1].
2837
2904
  #
2838
2905
  #
2839
2906
  #
2840
2907
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
2841
2908
  # @return [Types::TaskReportConfig]
2842
2909
  #
2910
+ # @!attribute [rw] schedule_details
2911
+ # The details about your [task schedule][1].
2912
+ #
2913
+ #
2914
+ #
2915
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
2916
+ # @return [Types::TaskScheduleDetails]
2917
+ #
2843
2918
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskResponse AWS API Documentation
2844
2919
  #
2845
2920
  class DescribeTaskResponse < Struct.new(
@@ -2859,7 +2934,9 @@ module Aws::DataSync
2859
2934
  :error_detail,
2860
2935
  :creation_time,
2861
2936
  :includes,
2862
- :task_report_config)
2937
+ :manifest_config,
2938
+ :task_report_config,
2939
+ :schedule_details)
2863
2940
  SENSITIVE = []
2864
2941
  include Aws::Structure
2865
2942
  end
@@ -3022,6 +3099,9 @@ module Aws::DataSync
3022
3099
  # @!attribute [rw] domain
3023
3100
  # Specifies the fully qualified domain name (FQDN) of the Microsoft
3024
3101
  # Active Directory that your storage virtual machine (SVM) belongs to.
3102
+ #
3103
+ # If you have multiple domains in your environment, configuring this
3104
+ # setting makes sure that DataSync connects to the right SVM.
3025
3105
  # @return [String]
3026
3106
  #
3027
3107
  # @!attribute [rw] mount_options
@@ -3035,37 +3115,15 @@ module Aws::DataSync
3035
3115
  # @return [String]
3036
3116
  #
3037
3117
  # @!attribute [rw] user
3038
- # Specifies a user name that can mount the location and access the
3039
- # files, folders, and metadata that you need in the SVM.
3040
- #
3041
- # If you provide a user in your Active Directory, note the following:
3042
- #
3043
- # * If you're using Directory Service for Microsoft Active Directory,
3044
- # the user must be a member of the Amazon Web Services Delegated FSx
3045
- # Administrators group.
3046
- #
3047
- # * If you're using a self-managed Active Directory, the user must be
3048
- # a member of either the Domain Admins group or a custom group that
3049
- # you specified for file system administration when you created your
3050
- # file system.
3051
- #
3052
- # Make sure that the user has the permissions it needs to copy the
3053
- # data you want:
3054
- #
3055
- # * `SE_TCB_NAME`: Required to set object ownership and file metadata.
3056
- # With this privilege, you also can copy NTFS discretionary access
3057
- # lists (DACLs).
3118
+ # Specifies a user that can mount and access the files, folders, and
3119
+ # metadata in your SVM.
3058
3120
  #
3059
- # * `SE_SECURITY_NAME`: May be needed to copy NTFS system access
3060
- # control lists (SACLs). This operation specifically requires the
3061
- # Windows privilege, which is granted to members of the Domain
3062
- # Admins group. If you configure your task to copy SACLs, make sure
3063
- # that the user has the required privileges. For information about
3064
- # copying SACLs, see [Ownership and permissions-related options][1].
3121
+ # For information about choosing a user with the right level of access
3122
+ # for your transfer, see [Using the SMB protocol][1].
3065
3123
  #
3066
3124
  #
3067
3125
  #
3068
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions
3126
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb
3069
3127
  # @return [String]
3070
3128
  #
3071
3129
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/FsxProtocolSmb AWS API Documentation
@@ -3449,17 +3507,17 @@ module Aws::DataSync
3449
3507
  # ListTaskExecutions
3450
3508
  #
3451
3509
  # @!attribute [rw] task_arn
3452
- # The Amazon Resource Name (ARN) of the task whose tasks you want to
3453
- # list.
3510
+ # Specifies the Amazon Resource Name (ARN) of the task that you want
3511
+ # execution information about.
3454
3512
  # @return [String]
3455
3513
  #
3456
3514
  # @!attribute [rw] max_results
3457
- # The maximum number of executed tasks to list.
3515
+ # Specifies how many results you want in the response.
3458
3516
  # @return [Integer]
3459
3517
  #
3460
3518
  # @!attribute [rw] next_token
3461
- # An opaque string that indicates the position at which to begin the
3462
- # next list of the executed tasks.
3519
+ # Specifies an opaque string that indicates the position at which to
3520
+ # begin the next list of results in the response.
3463
3521
  # @return [String]
3464
3522
  #
3465
3523
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTaskExecutionsRequest AWS API Documentation
@@ -3475,12 +3533,12 @@ module Aws::DataSync
3475
3533
  # ListTaskExecutionsResponse
3476
3534
  #
3477
3535
  # @!attribute [rw] task_executions
3478
- # A list of executed tasks.
3536
+ # A list of the task's executions.
3479
3537
  # @return [Array<Types::TaskExecutionListEntry>]
3480
3538
  #
3481
3539
  # @!attribute [rw] next_token
3482
- # An opaque string that indicates the position at which to begin
3483
- # returning the next list of executed tasks.
3540
+ # The opaque string that indicates the position to begin the next list
3541
+ # of results in the response.
3484
3542
  # @return [String]
3485
3543
  #
3486
3544
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTaskExecutionsResponse AWS API Documentation
@@ -3628,6 +3686,58 @@ module Aws::DataSync
3628
3686
  include Aws::Structure
3629
3687
  end
3630
3688
 
3689
+ # Configures a manifest, which is a list of files or objects that you
3690
+ # want DataSync to transfer. For more information and configuration
3691
+ # examples, see [Specifying what DataSync transfers by using a
3692
+ # manifest][1].
3693
+ #
3694
+ #
3695
+ #
3696
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
3697
+ #
3698
+ # @!attribute [rw] action
3699
+ # Specifies what DataSync uses the manifest for.
3700
+ # @return [String]
3701
+ #
3702
+ # @!attribute [rw] format
3703
+ # Specifies the file format of your manifest. For more information,
3704
+ # see [Creating a manifest][1].
3705
+ #
3706
+ #
3707
+ #
3708
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-create
3709
+ # @return [String]
3710
+ #
3711
+ # @!attribute [rw] source
3712
+ # Specifies the manifest that you want DataSync to use and where it's
3713
+ # hosted.
3714
+ #
3715
+ # <note markdown="1"> You must specify this parameter if you're configuring a new
3716
+ # manifest on or after February 7, 2024.
3717
+ #
3718
+ # If you don't, you'll get a 400 status code and
3719
+ # `ValidationException` error stating that you're missing the IAM
3720
+ # role for DataSync to access the S3 bucket where you're hosting your
3721
+ # manifest. For more information, see [Providing DataSync access to
3722
+ # your manifest][1].
3723
+ #
3724
+ # </note>
3725
+ #
3726
+ #
3727
+ #
3728
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access
3729
+ # @return [Types::SourceManifestConfig]
3730
+ #
3731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ManifestConfig AWS API Documentation
3732
+ #
3733
+ class ManifestConfig < Struct.new(
3734
+ :action,
3735
+ :format,
3736
+ :source)
3737
+ SENSITIVE = []
3738
+ include Aws::Structure
3739
+ end
3740
+
3631
3741
  # The performance data that DataSync Discovery collects about an
3632
3742
  # on-premises storage system resource.
3633
3743
  #
@@ -4033,54 +4143,68 @@ module Aws::DataSync
4033
4143
  # integrity, set bandwidth limits for your task, among other options.
4034
4144
  #
4035
4145
  # Each option has a default value. Unless you need to, you don't have
4036
- # to configure any of these options before starting your task.
4146
+ # to configure any option before calling [StartTaskExecution][1].
4147
+ #
4148
+ # You also can override your task options for each task execution. For
4149
+ # example, you might want to adjust the `LogLevel` for an individual
4150
+ # execution.
4151
+ #
4152
+ #
4153
+ #
4154
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
4037
4155
  #
4038
4156
  # @!attribute [rw] verify_mode
4039
4157
  # Specifies how and when DataSync checks the integrity of your data
4040
4158
  # during a transfer.
4041
4159
  #
4042
- # Default value: `POINT_IN_TIME_CONSISTENT`
4160
+ # * `ONLY_FILES_TRANSFERRED` (recommended) - DataSync calculates the
4161
+ # checksum of transferred files and metadata at the source location.
4162
+ # At the end of the transfer, DataSync then compares this checksum
4163
+ # to the checksum calculated on those files at the destination.
4043
4164
  #
4044
- # `ONLY_FILES_TRANSFERRED` (recommended): DataSync calculates the
4045
- # checksum of transferred files and metadata at the source location.
4046
- # At the end of the transfer, DataSync then compares this checksum to
4047
- # the checksum calculated on those files at the destination.
4165
+ # We recommend this option when transferring to S3 Glacier Flexible
4166
+ # Retrieval or S3 Glacier Deep Archive storage classes. For more
4167
+ # information, see [Storage class considerations with Amazon S3
4168
+ # locations][1].
4048
4169
  #
4049
- # We recommend this option when transferring to S3 Glacier Flexible
4050
- # Retrieval or S3 Glacier Deep Archive storage classes. For more
4051
- # information, see [Storage class considerations with Amazon S3
4052
- # locations][1].
4170
+ # * `POINT_IN_TIME_CONSISTENT` (default) - At the end of the transfer,
4171
+ # DataSync scans the entire source and destination to verify that
4172
+ # both locations are fully synchronized.
4053
4173
  #
4054
- # `POINT_IN_TIME_CONSISTENT`: At the end of the transfer, DataSync
4055
- # scans the entire source and destination to verify that both
4056
- # locations are fully synchronized.
4174
+ # If you use a [manifest][2], DataSync only scans and verifies
4175
+ # what's listed in the manifest.
4057
4176
  #
4058
- # You can't use this option when transferring to S3 Glacier Flexible
4059
- # Retrieval or S3 Glacier Deep Archive storage classes. For more
4060
- # information, see [Storage class considerations with Amazon S3
4061
- # locations][1].
4177
+ # You can't use this option when transferring to S3 Glacier
4178
+ # Flexible Retrieval or S3 Glacier Deep Archive storage classes. For
4179
+ # more information, see [Storage class considerations with Amazon S3
4180
+ # locations][1].
4062
4181
  #
4063
- # `NONE`: DataSync doesn't run additional verification at the end of
4064
- # the transfer. All data transmissions are still integrity-checked
4065
- # with checksum verification during the transfer.
4182
+ # * `NONE` - DataSync doesn't run additional verification at the end
4183
+ # of the transfer. All data transmissions are still
4184
+ # integrity-checked with checksum verification during the transfer.
4066
4185
  #
4067
4186
  #
4068
4187
  #
4069
4188
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
4189
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
4070
4190
  # @return [String]
4071
4191
  #
4072
4192
  # @!attribute [rw] overwrite_mode
4073
- # Specifies whether data at the destination location should be
4074
- # overwritten or preserved. If set to `NEVER`, a destination file for
4075
- # example will not be replaced by a source file (even if the
4076
- # destination file differs from the source file). If you modify files
4077
- # in the destination and you sync the files, you can use this value to
4078
- # protect against overwriting those changes.
4193
+ # Specifies whether DataSync should modify or preserve data at the
4194
+ # destination location.
4195
+ #
4196
+ # * `ALWAYS` (default) - DataSync modifies data in the destination
4197
+ # location when source data (including metadata) has changed.
4079
4198
  #
4080
- # Some storage classes have specific behaviors that can affect your
4081
- # Amazon S3 storage cost. For detailed information, see
4082
- # [Considerations when working with Amazon S3 storage classes in
4083
- # DataSync][1].
4199
+ # If DataSync overwrites objects, you might incur additional charges
4200
+ # for certain Amazon S3 storage classes (for example, for retrieval
4201
+ # or early deletion). For more information, see [Storage class
4202
+ # considerations with Amazon S3 transfers][1].
4203
+ #
4204
+ # * `NEVER` - DataSync doesn't overwrite data in the destination
4205
+ # location even if the source data has changed. You can use this
4206
+ # option to protect against overwriting changes made to files or
4207
+ # objects in the destination.
4084
4208
  #
4085
4209
  #
4086
4210
  #
@@ -4089,22 +4213,19 @@ module Aws::DataSync
4089
4213
  #
4090
4214
  # @!attribute [rw] atime
4091
4215
  # Specifies whether to preserve metadata indicating the last time a
4092
- # file was read or written to. If you set `Atime` to `BEST_EFFORT`,
4093
- # DataSync attempts to preserve the original `Atime` attribute on all
4094
- # source files (that is, the version before the `PREPARING` phase of
4095
- # the task execution).
4216
+ # file was read or written to.
4096
4217
  #
4097
4218
  # <note markdown="1"> The behavior of `Atime` isn't fully standard across platforms, so
4098
4219
  # DataSync can only do this on a best-effort basis.
4099
4220
  #
4100
4221
  # </note>
4101
4222
  #
4102
- # Default value: `BEST_EFFORT`
4103
- #
4104
- # `BEST_EFFORT`: Attempt to preserve the per-file `Atime` value
4105
- # (recommended).
4223
+ # * `BEST_EFFORT` (default) - DataSync attempts to preserve the
4224
+ # original `Atime` attribute on all source files (that is, the
4225
+ # version before the `PREPARING` phase of the task execution). This
4226
+ # option is recommended.
4106
4227
  #
4107
- # `NONE`: Ignore `Atime`.
4228
+ # * `NONE` - Ignores `Atime`.
4108
4229
  #
4109
4230
  # <note markdown="1"> If `Atime` is set to `BEST_EFFORT`, `Mtime` must be set to
4110
4231
  # `PRESERVE`.
@@ -4120,11 +4241,10 @@ module Aws::DataSync
4120
4241
  # execution. This option is required when you need to run the a task
4121
4242
  # more than once.
4122
4243
  #
4123
- # Default Value: `PRESERVE`
4124
- #
4125
- # `PRESERVE`: Preserve original `Mtime` (recommended)
4244
+ # * `PRESERVE` (default) - Preserves original `Mtime`, which is
4245
+ # recommended.
4126
4246
  #
4127
- # `NONE`: Ignore `Mtime`.
4247
+ # * `NONE` - Ignores `Mtime`.
4128
4248
  #
4129
4249
  # <note markdown="1"> If `Mtime` is set to `PRESERVE`, `Atime` must be set to
4130
4250
  # `BEST_EFFORT`.
@@ -4137,15 +4257,12 @@ module Aws::DataSync
4137
4257
  # @!attribute [rw] uid
4138
4258
  # Specifies the POSIX user ID (UID) of the file's owner.
4139
4259
  #
4140
- # For more information, see [Metadata copied by DataSync][1].
4141
- #
4142
- # Default value: `INT_VALUE`. This preserves the integer value of the
4143
- # ID.
4260
+ # * `INT_VALUE` (default) - Preserves the integer value of UID and
4261
+ # group ID (GID), which is recommended.
4144
4262
  #
4145
- # `INT_VALUE`: Preserve the integer value of UID and group ID (GID)
4146
- # (recommended).
4263
+ # * `NONE` - Ignores UID and GID.
4147
4264
  #
4148
- # `NONE`: Ignore UID and GID.
4265
+ # For more information, see [Metadata copied by DataSync][1].
4149
4266
  #
4150
4267
  #
4151
4268
  #
@@ -4155,15 +4272,12 @@ module Aws::DataSync
4155
4272
  # @!attribute [rw] gid
4156
4273
  # Specifies the POSIX group ID (GID) of the file's owners.
4157
4274
  #
4158
- # For more information, see [Metadata copied by DataSync][1].
4159
- #
4160
- # Default value: `INT_VALUE`. This preserves the integer value of the
4161
- # ID.
4275
+ # * `INT_VALUE` (default) - Preserves the integer value of user ID
4276
+ # (UID) and GID, which is recommended.
4162
4277
  #
4163
- # `INT_VALUE`: Preserve the integer value of user ID (UID) and GID
4164
- # (recommended).
4278
+ # * `NONE` - Ignores UID and GID.
4165
4279
  #
4166
- # `NONE`: Ignore UID and GID.
4280
+ # For more information, see [Metadata copied by DataSync][1].
4167
4281
  #
4168
4282
  #
4169
4283
  #
@@ -4178,12 +4292,11 @@ module Aws::DataSync
4178
4292
  # For detailed information, see [Considerations when working with
4179
4293
  # Amazon S3 storage classes in DataSync][1].
4180
4294
  #
4181
- # Default value: `PRESERVE`
4182
- #
4183
- # `PRESERVE`: Ignore such destination files (recommended).
4295
+ # * `PRESERVE` (default) - Ignores such destination files, which is
4296
+ # recommended.
4184
4297
  #
4185
- # `REMOVE`: Delete destination files that aren’t present in the
4186
- # source.
4298
+ # * `REMOVE` - Deletes destination files that aren’t present in the
4299
+ # source.
4187
4300
  #
4188
4301
  # <note markdown="1"> If you set this parameter to `REMOVE`, you can't set `TransferMode`
4189
4302
  # to `ALL`. When you transfer all data, DataSync doesn't scan your
@@ -4207,12 +4320,10 @@ module Aws::DataSync
4207
4320
  #
4208
4321
  # </note>
4209
4322
  #
4210
- # Default value: `NONE`
4211
- #
4212
- # `NONE`: Ignore special devices (recommended).
4323
+ # * `NONE` (default) - Ignores special devices (recommended).
4213
4324
  #
4214
- # `PRESERVE`: Preserve character and block device metadata. This
4215
- # option currently isn't supported for Amazon EFS.
4325
+ # * `PRESERVE` - Preserves character and block device metadata. This
4326
+ # option currently isn't supported for Amazon EFS.
4216
4327
  # @return [String]
4217
4328
  #
4218
4329
  # @!attribute [rw] posix_permissions
@@ -4221,11 +4332,10 @@ module Aws::DataSync
4221
4332
  #
4222
4333
  # For more information, see [Metadata copied by DataSync][1].
4223
4334
  #
4224
- # Default value: `PRESERVE`
4335
+ # * `PRESERVE` (default) - Preserves POSIX-style permissions, which is
4336
+ # recommended.
4225
4337
  #
4226
- # `PRESERVE`: Preserve POSIX-style permissions (recommended).
4227
- #
4228
- # `NONE`: Ignore permissions.
4338
+ # * `NONE` - Ignores POSIX-style permissions.
4229
4339
  #
4230
4340
  # <note markdown="1"> DataSync can preserve extant permissions of a source location.
4231
4341
  #
@@ -4257,10 +4367,13 @@ module Aws::DataSync
4257
4367
  # CloudWatch Logs log group. To specify the log group, see
4258
4368
  # [CloudWatchLogGroupArn][1].
4259
4369
  #
4260
- # If you set `LogLevel` to `OFF`, no logs are published. `BASIC`
4261
- # publishes logs on errors for individual files transferred.
4262
- # `TRANSFER` publishes logs for every file or object that is
4263
- # transferred and integrity checked.
4370
+ # * `BASIC` - Publishes logs with only basic information (such as
4371
+ # transfer errors).
4372
+ #
4373
+ # * `TRANSFER` - Publishes logs for all files or objects that your
4374
+ # DataSync task transfers and performs data-integrity checks on.
4375
+ #
4376
+ # * `OFF` - No logs are published.
4264
4377
  #
4265
4378
  #
4266
4379
  #
@@ -4273,12 +4386,12 @@ module Aws::DataSync
4273
4386
  # transfers all the content from the source (without comparing what's
4274
4387
  # in the destination).
4275
4388
  #
4276
- # `CHANGED`: DataSync copies only data or metadata that is new or
4277
- # different content from the source location to the destination
4278
- # location.
4389
+ # * `CHANGED` (default) - DataSync copies only data or metadata that
4390
+ # is new or different content from the source location to the
4391
+ # destination location.
4279
4392
  #
4280
- # `ALL`: DataSync copies all source location content to the
4281
- # destination (without comparing what's in the destination).
4393
+ # * `ALL` - DataSync copies everything in the source to the
4394
+ # destination without comparing differences between the locations.
4282
4395
  # @return [String]
4283
4396
  #
4284
4397
  # @!attribute [rw] security_descriptor_copy_flags
@@ -4290,52 +4403,53 @@ module Aws::DataSync
4290
4403
  # Server locations. For more information, see [how DataSync handles
4291
4404
  # metadata][1].
4292
4405
  #
4293
- # Default value: `OWNER_DACL`
4294
- #
4295
- # `OWNER_DACL`: For each copied object, DataSync copies the following
4296
- # metadata:
4406
+ # * `OWNER_DACL` (default) - For each copied object, DataSync copies
4407
+ # the following metadata:
4297
4408
  #
4298
- # * The object owner.
4409
+ # * The object owner.
4299
4410
  #
4300
- # * NTFS discretionary access control lists (DACLs), which determine
4301
- # whether to grant access to an object.
4411
+ # * NTFS discretionary access control lists (DACLs), which determine
4412
+ # whether to grant access to an object.
4302
4413
  #
4303
- # DataSync won't copy NTFS system access control lists (SACLs) with
4304
- # this option.
4414
+ # DataSync won't copy NTFS system access control lists (SACLs)
4415
+ # with this option.
4305
4416
  #
4306
- # `OWNER_DACL_SACL`: For each copied object, DataSync copies the
4307
- # following metadata:
4417
+ # * `OWNER_DACL_SACL` - For each copied object, DataSync copies the
4418
+ # following metadata:
4308
4419
  #
4309
- # * The object owner.
4420
+ # * The object owner.
4310
4421
  #
4311
- # * NTFS discretionary access control lists (DACLs), which determine
4312
- # whether to grant access to an object.
4422
+ # * NTFS discretionary access control lists (DACLs), which determine
4423
+ # whether to grant access to an object.
4313
4424
  #
4314
- # * SACLs, which are used by administrators to log attempts to access
4315
- # a secured object.
4425
+ # * SACLs, which are used by administrators to log attempts to
4426
+ # access a secured object.
4316
4427
  #
4317
- # Copying SACLs requires granting additional permissions to the
4318
- # Windows user that DataSync uses to access your SMB location. For
4319
- # information about choosing a user that ensures sufficient
4320
- # permissions to files, folders, and metadata, see
4321
- # [user](create-smb-location.html#SMBuser).
4428
+ # Copying SACLs requires granting additional permissions to the
4429
+ # Windows user that DataSync uses to access your SMB location. For
4430
+ # information about choosing a user with the right permissions,
4431
+ # see required permissions for [SMB][2], [FSx for Windows File
4432
+ # Server][3], or [FSx for ONTAP][4] (depending on the type of
4433
+ # location in your transfer).
4322
4434
  #
4323
- # `NONE`: None of the SMB security descriptor components are copied.
4324
- # Destination objects are owned by the user that was provided for
4325
- # accessing the destination location. DACLs and SACLs are set based on
4326
- # the destination server’s configuration.
4435
+ # * `NONE` - None of the SMB security descriptor components are
4436
+ # copied. Destination objects are owned by the user that was
4437
+ # provided for accessing the destination location. DACLs and SACLs
4438
+ # are set based on the destination server’s configuration.
4327
4439
  #
4328
4440
  #
4329
4441
  #
4330
4442
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html
4443
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
4444
+ # [3]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions
4445
+ # [4]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb
4331
4446
  # @return [String]
4332
4447
  #
4333
4448
  # @!attribute [rw] object_tags
4334
- # Specifies whether object tags are preserved when transferring
4335
- # between object storage systems. If you want your DataSync task to
4336
- # ignore object tags, specify the `NONE` value.
4337
- #
4338
- # Default Value: `PRESERVE`
4449
+ # Specifies whether you want DataSync to `PRESERVE` object tags
4450
+ # (default behavior) when transferring between object storage systems.
4451
+ # If you want your DataSync task to ignore object tags, specify the
4452
+ # `NONE` value.
4339
4453
  # @return [String]
4340
4454
  #
4341
4455
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Options AWS API Documentation
@@ -4396,17 +4510,6 @@ module Aws::DataSync
4396
4510
  #
4397
4511
  # @!attribute [rw] version
4398
4512
  # The version of the DataSync agent.
4399
- #
4400
- # Beginning December 7, 2023, we will discontinue version 1 DataSync
4401
- # agents. Check the DataSync console to see if you have affected
4402
- # agents. If you do, [replace][1] those agents before then to avoid
4403
- # data transfer or storage discovery disruptions. If you need more
4404
- # help, contact [Amazon Web Services Support][2].
4405
- #
4406
- #
4407
- #
4408
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html
4409
- # [2]: https://aws.amazon.com/contact-us/
4410
4513
  # @return [String]
4411
4514
  #
4412
4515
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Platform AWS API Documentation
@@ -4582,7 +4685,7 @@ module Aws::DataSync
4582
4685
  #
4583
4686
  #
4584
4687
  #
4585
- # [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
4688
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
4586
4689
  # @return [String]
4587
4690
  #
4588
4691
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ReportDestinationS3 AWS API Documentation
@@ -4769,14 +4872,18 @@ module Aws::DataSync
4769
4872
  include Aws::Structure
4770
4873
  end
4771
4874
 
4772
- # The Amazon Resource Name (ARN) of the Identity and Access Management
4773
- # (IAM) role used to access an Amazon S3 bucket.
4875
+ # Specifies the Amazon Resource Name (ARN) of the Identity and Access
4876
+ # Management (IAM) role that DataSync uses to access your S3 bucket.
4877
+ #
4878
+ # For more information, see [Accessing S3 buckets][1].
4879
+ #
4880
+ #
4774
4881
  #
4775
- # For detailed information about using such a role, see Creating a
4776
- # Location for Amazon S3 in the *DataSync User Guide*.
4882
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access
4777
4883
  #
4778
4884
  # @!attribute [rw] bucket_access_role_arn
4779
- # The ARN of the IAM role for accessing the S3 bucket.
4885
+ # Specifies the ARN of the IAM role that DataSync uses to access your
4886
+ # S3 bucket.
4780
4887
  # @return [String]
4781
4888
  #
4782
4889
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/S3Config AWS API Documentation
@@ -4787,6 +4894,51 @@ module Aws::DataSync
4787
4894
  include Aws::Structure
4788
4895
  end
4789
4896
 
4897
+ # Specifies the S3 bucket where you're hosting the manifest that you
4898
+ # want DataSync to use. For more information and configuration examples,
4899
+ # see [Specifying what DataSync transfers by using a manifest][1].
4900
+ #
4901
+ #
4902
+ #
4903
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
4904
+ #
4905
+ # @!attribute [rw] manifest_object_path
4906
+ # Specifies the Amazon S3 object key of your manifest. This can
4907
+ # include a prefix (for example, `prefix/my-manifest.csv`).
4908
+ # @return [String]
4909
+ #
4910
+ # @!attribute [rw] bucket_access_role_arn
4911
+ # Specifies the Identity and Access Management (IAM) role that allows
4912
+ # DataSync to access your manifest. For more information, see
4913
+ # [Providing DataSync access to your manifest][1].
4914
+ #
4915
+ #
4916
+ #
4917
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access
4918
+ # @return [String]
4919
+ #
4920
+ # @!attribute [rw] s3_bucket_arn
4921
+ # Specifies the Amazon Resource Name (ARN) of the S3 bucket where
4922
+ # you're hosting your manifest.
4923
+ # @return [String]
4924
+ #
4925
+ # @!attribute [rw] manifest_object_version_id
4926
+ # Specifies the object version ID of the manifest that you want
4927
+ # DataSync to use. If you don't set this, DataSync uses the latest
4928
+ # version of the object.
4929
+ # @return [String]
4930
+ #
4931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/S3ManifestConfig AWS API Documentation
4932
+ #
4933
+ class S3ManifestConfig < Struct.new(
4934
+ :manifest_object_path,
4935
+ :bucket_access_role_arn,
4936
+ :s3_bucket_arn,
4937
+ :manifest_object_version_id)
4938
+ SENSITIVE = []
4939
+ include Aws::Structure
4940
+ end
4941
+
4790
4942
  # Specifies the version of the Server Message Block (SMB) protocol that
4791
4943
  # DataSync uses to access an SMB file server.
4792
4944
  #
@@ -4837,6 +4989,26 @@ module Aws::DataSync
4837
4989
  include Aws::Structure
4838
4990
  end
4839
4991
 
4992
+ # Specifies the manifest that you want DataSync to use and where it's
4993
+ # hosted. For more information and configuration examples, see
4994
+ # [Specifying what DataSync transfers by using a manifest][1].
4995
+ #
4996
+ #
4997
+ #
4998
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
4999
+ #
5000
+ # @!attribute [rw] s3
5001
+ # Specifies the S3 bucket where you're hosting your manifest.
5002
+ # @return [Types::S3ManifestConfig]
5003
+ #
5004
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/SourceManifestConfig AWS API Documentation
5005
+ #
5006
+ class SourceManifestConfig < Struct.new(
5007
+ :s3)
5008
+ SENSITIVE = []
5009
+ include Aws::Structure
5010
+ end
5011
+
4840
5012
  # @!attribute [rw] storage_system_arn
4841
5013
  # Specifies the Amazon Resource Name (ARN) of the on-premises storage
4842
5014
  # system that you want to run the discovery job on.
@@ -4905,7 +5077,15 @@ module Aws::DataSync
4905
5077
  # options.
4906
5078
  #
4907
5079
  # Each option has a default value. Unless you need to, you don't have
4908
- # to configure any of these options before starting your task.
5080
+ # to configure any option before calling [StartTaskExecution][1].
5081
+ #
5082
+ # You also can override your task options for each task execution. For
5083
+ # example, you might want to adjust the `LogLevel` for an individual
5084
+ # execution.
5085
+ #
5086
+ #
5087
+ #
5088
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
4909
5089
  # @return [Types::Options]
4910
5090
  #
4911
5091
  # @!attribute [rw] includes
@@ -4923,6 +5103,46 @@ module Aws::DataSync
4923
5103
  # "\|" (that is, a pipe), for example, `"/folder1|/folder2"`.
4924
5104
  # @return [Array<Types::FilterRule>]
4925
5105
  #
5106
+ # @!attribute [rw] manifest_config
5107
+ # Configures a manifest, which is a list of files or objects that you
5108
+ # want DataSync to transfer. For more information and configuration
5109
+ # examples, see [Specifying what DataSync transfers by using a
5110
+ # manifest][1].
5111
+ #
5112
+ # When using this parameter, your caller identity (the role that
5113
+ # you're using DataSync with) must have the `iam:PassRole`
5114
+ # permission. The [AWSDataSyncFullAccess][2] policy includes this
5115
+ # permission.
5116
+ #
5117
+ # To remove a manifest configuration, specify this parameter with an
5118
+ # empty value.
5119
+ #
5120
+ #
5121
+ #
5122
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
5123
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
5124
+ # @return [Types::ManifestConfig]
5125
+ #
5126
+ # @!attribute [rw] task_report_config
5127
+ # Specifies how you want to configure a task report, which provides
5128
+ # detailed information about your DataSync transfer. For more
5129
+ # information, see [Monitoring your DataSync transfers with task
5130
+ # reports][1].
5131
+ #
5132
+ # When using this parameter, your caller identity (the role that
5133
+ # you're using DataSync with) must have the `iam:PassRole`
5134
+ # permission. The [AWSDataSyncFullAccess][2] policy includes this
5135
+ # permission.
5136
+ #
5137
+ # To remove a task report configuration, specify this parameter as
5138
+ # empty.
5139
+ #
5140
+ #
5141
+ #
5142
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
5143
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
5144
+ # @return [Types::TaskReportConfig]
5145
+ #
4926
5146
  # @!attribute [rw] tags
4927
5147
  # Specifies the tags that you want to apply to the Amazon Resource
4928
5148
  # Name (ARN) representing the task execution.
@@ -4931,11 +5151,6 @@ module Aws::DataSync
4931
5151
  # for your DataSync resources.
4932
5152
  # @return [Array<Types::TagListEntry>]
4933
5153
  #
4934
- # @!attribute [rw] task_report_config
4935
- # Specifies how you want to configure a task report, which provides
4936
- # detailed information about for your DataSync transfer.
4937
- # @return [Types::TaskReportConfig]
4938
- #
4939
5154
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartTaskExecutionRequest AWS API Documentation
4940
5155
  #
4941
5156
  class StartTaskExecutionRequest < Struct.new(
@@ -4943,8 +5158,9 @@ module Aws::DataSync
4943
5158
  :override_options,
4944
5159
  :includes,
4945
5160
  :excludes,
4946
- :tags,
4947
- :task_report_config)
5161
+ :manifest_config,
5162
+ :task_report_config,
5163
+ :tags)
4948
5164
  SENSITIVE = []
4949
5165
  include Aws::Structure
4950
5166
  end
@@ -5046,21 +5262,24 @@ module Aws::DataSync
5046
5262
  #
5047
5263
  class TagResourceResponse < Aws::EmptyStructure; end
5048
5264
 
5049
- # Represents a single entry in a list of task executions.
5050
- # `TaskExecutionListEntry` returns an array that contains a list of
5051
- # specific invocations of a task when the [ListTaskExecutions][1]
5052
- # operation is called.
5265
+ # Represents a single entry in a list of DataSync task executions
5266
+ # that's returned with the [ListTaskExecutions][1] operation.
5053
5267
  #
5054
5268
  #
5055
5269
  #
5056
5270
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html
5057
5271
  #
5058
5272
  # @!attribute [rw] task_execution_arn
5059
- # The Amazon Resource Name (ARN) of the task that was executed.
5273
+ # The Amazon Resource Name (ARN) of a task execution.
5060
5274
  # @return [String]
5061
5275
  #
5062
5276
  # @!attribute [rw] status
5063
- # The status of a task execution.
5277
+ # The status of a task execution. For more information, see [Task
5278
+ # execution statuses][1].
5279
+ #
5280
+ #
5281
+ #
5282
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-execution-statuses
5064
5283
  # @return [String]
5065
5284
  #
5066
5285
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskExecutionListEntry AWS API Documentation
@@ -5276,23 +5495,97 @@ module Aws::DataSync
5276
5495
  include Aws::Structure
5277
5496
  end
5278
5497
 
5279
- # Specifies the schedule you want your task to use for repeated
5280
- # executions. For more information, see [Schedule Expressions for
5281
- # Rules][1].
5498
+ # Configures your DataSync task to run on a [schedule][1] (at a minimum
5499
+ # interval of 1 hour).
5282
5500
  #
5283
5501
  #
5284
5502
  #
5285
- # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html
5503
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
5286
5504
  #
5287
5505
  # @!attribute [rw] schedule_expression
5288
- # A cron expression that specifies when DataSync initiates a scheduled
5289
- # transfer from a source to a destination location.
5506
+ # Specifies your task schedule by using a cron expression in UTC time.
5507
+ # For information about cron expression syntax, see the [ *Amazon
5508
+ # EventBridge User Guide* ][1].
5509
+ #
5510
+ #
5511
+ #
5512
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html
5513
+ # @return [String]
5514
+ #
5515
+ # @!attribute [rw] status
5516
+ # Specifies whether to enable or disable your task schedule. Your
5517
+ # schedule is enabled by default, but there can be situations where
5518
+ # you need to disable it. For example, you might need to pause a
5519
+ # recurring transfer or fix an issue with your task or perform
5520
+ # maintenance on your storage system.
5521
+ #
5522
+ # DataSync might disable your schedule automatically if your task
5523
+ # fails repeatedly with the same error. For more information, see
5524
+ # [TaskScheduleDetails][1].
5525
+ #
5526
+ #
5527
+ #
5528
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html
5290
5529
  # @return [String]
5291
5530
  #
5292
5531
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskSchedule AWS API Documentation
5293
5532
  #
5294
5533
  class TaskSchedule < Struct.new(
5295
- :schedule_expression)
5534
+ :schedule_expression,
5535
+ :status)
5536
+ SENSITIVE = []
5537
+ include Aws::Structure
5538
+ end
5539
+
5540
+ # Provides information about your DataSync [task schedule][1].
5541
+ #
5542
+ #
5543
+ #
5544
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
5545
+ #
5546
+ # @!attribute [rw] status_update_time
5547
+ # Indicates the last time the status of your task schedule changed.
5548
+ # For example, if DataSync automatically disables your schedule
5549
+ # because of a repeated error, you can see when the schedule was
5550
+ # disabled.
5551
+ # @return [Time]
5552
+ #
5553
+ # @!attribute [rw] disabled_reason
5554
+ # Provides a reason if the task schedule is disabled.
5555
+ #
5556
+ # If your schedule is disabled by `USER`, you see a `Manually disabled
5557
+ # by user.` message.
5558
+ #
5559
+ # If your schedule is disabled by `SERVICE`, you see an error message
5560
+ # to help you understand why the task keeps failing. For information
5561
+ # on resolving DataSync errors, see [Troubleshooting issues with
5562
+ # DataSync transfers][1].
5563
+ #
5564
+ #
5565
+ #
5566
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html
5567
+ # @return [String]
5568
+ #
5569
+ # @!attribute [rw] disabled_by
5570
+ # Indicates how your task schedule was disabled.
5571
+ #
5572
+ # * `USER` - Your schedule was manually disabled by using the
5573
+ # [UpdateTask][1] operation or DataSync console.
5574
+ #
5575
+ # * `SERVICE` - Your schedule was automatically disabled by DataSync
5576
+ # because the task failed repeatedly with the same error.
5577
+ #
5578
+ #
5579
+ #
5580
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_UpdateTask.html
5581
+ # @return [String]
5582
+ #
5583
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskScheduleDetails AWS API Documentation
5584
+ #
5585
+ class TaskScheduleDetails < Struct.new(
5586
+ :status_update_time,
5587
+ :disabled_reason,
5588
+ :disabled_by)
5296
5589
  SENSITIVE = []
5297
5590
  include Aws::Structure
5298
5591
  end
@@ -5827,7 +6120,15 @@ module Aws::DataSync
5827
6120
  # options.
5828
6121
  #
5829
6122
  # Each option has a default value. Unless you need to, you don't have
5830
- # to configure any of these options before starting your task.
6123
+ # to configure any option before calling [StartTaskExecution][1].
6124
+ #
6125
+ # You also can override your task options for each task execution. For
6126
+ # example, you might want to adjust the `LogLevel` for an individual
6127
+ # execution.
6128
+ #
6129
+ #
6130
+ #
6131
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
5831
6132
  # @return [Types::Options]
5832
6133
  #
5833
6134
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecutionRequest AWS API Documentation
@@ -5846,8 +6147,7 @@ module Aws::DataSync
5846
6147
  # UpdateTaskResponse
5847
6148
  #
5848
6149
  # @!attribute [rw] task_arn
5849
- # The Amazon Resource Name (ARN) of the resource name of the task to
5850
- # update.
6150
+ # Specifies the ARN of the task that you want to update.
5851
6151
  # @return [String]
5852
6152
  #
5853
6153
  # @!attribute [rw] options
@@ -5858,13 +6158,22 @@ module Aws::DataSync
5858
6158
  # options.
5859
6159
  #
5860
6160
  # Each option has a default value. Unless you need to, you don't have
5861
- # to configure any of these options before starting your task.
6161
+ # to configure any option before calling [StartTaskExecution][1].
6162
+ #
6163
+ # You also can override your task options for each task execution. For
6164
+ # example, you might want to adjust the `LogLevel` for an individual
6165
+ # execution.
6166
+ #
6167
+ #
6168
+ #
6169
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
5862
6170
  # @return [Types::Options]
5863
6171
  #
5864
6172
  # @!attribute [rw] excludes
5865
- # Specifies a list of filter rules that exclude specific data during
5866
- # your transfer. For more information and examples, see [Filtering
5867
- # data transferred by DataSync][1].
6173
+ # Specifies exclude filters that define the files, objects, and
6174
+ # folders in your source location that you don't want DataSync to
6175
+ # transfer. For more information and examples, see [Specifying what
6176
+ # DataSync transfers by using filters][1].
5868
6177
  #
5869
6178
  #
5870
6179
  #
@@ -5872,12 +6181,8 @@ module Aws::DataSync
5872
6181
  # @return [Array<Types::FilterRule>]
5873
6182
  #
5874
6183
  # @!attribute [rw] schedule
5875
- # Specifies a schedule used to periodically transfer files from a
5876
- # source to a destination location. You can configure your task to
5877
- # execute hourly, daily, weekly or on specific days of the week. You
5878
- # control when in the day or hour you want the task to execute. The
5879
- # time you specify is UTC time. For more information, see [Scheduling
5880
- # your task][1].
6184
+ # Specifies a schedule for when you want your task to run. For more
6185
+ # information, see [Scheduling your task][1].
5881
6186
  #
5882
6187
  #
5883
6188
  #
@@ -5885,27 +6190,62 @@ module Aws::DataSync
5885
6190
  # @return [Types::TaskSchedule]
5886
6191
  #
5887
6192
  # @!attribute [rw] name
5888
- # The name of the task to update.
6193
+ # Specifies the name of your task.
5889
6194
  # @return [String]
5890
6195
  #
5891
6196
  # @!attribute [rw] cloud_watch_log_group_arn
5892
- # The Amazon Resource Name (ARN) of the resource name of the Amazon
5893
- # CloudWatch log group.
6197
+ # Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log
6198
+ # group for monitoring your task.
5894
6199
  # @return [String]
5895
6200
  #
5896
6201
  # @!attribute [rw] includes
5897
- # Specifies a list of filter rules that include specific data during
5898
- # your transfer. For more information and examples, see [Filtering
5899
- # data transferred by DataSync][1].
6202
+ # Specifies include filters define the files, objects, and folders in
6203
+ # your source location that you want DataSync to transfer. For more
6204
+ # information and examples, see [Specifying what DataSync transfers by
6205
+ # using filters][1].
5900
6206
  #
5901
6207
  #
5902
6208
  #
5903
6209
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
5904
6210
  # @return [Array<Types::FilterRule>]
5905
6211
  #
6212
+ # @!attribute [rw] manifest_config
6213
+ # Configures a manifest, which is a list of files or objects that you
6214
+ # want DataSync to transfer. For more information and configuration
6215
+ # examples, see [Specifying what DataSync transfers by using a
6216
+ # manifest][1].
6217
+ #
6218
+ # When using this parameter, your caller identity (the IAM role that
6219
+ # you're using DataSync with) must have the `iam:PassRole`
6220
+ # permission. The [AWSDataSyncFullAccess][2] policy includes this
6221
+ # permission.
6222
+ #
6223
+ # To remove a manifest configuration, specify this parameter as empty.
6224
+ #
6225
+ #
6226
+ #
6227
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
6228
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
6229
+ # @return [Types::ManifestConfig]
6230
+ #
5906
6231
  # @!attribute [rw] task_report_config
5907
6232
  # Specifies how you want to configure a task report, which provides
5908
- # detailed information about for your DataSync transfer.
6233
+ # detailed information about your DataSync transfer. For more
6234
+ # information, see [Monitoring your DataSync transfers with task
6235
+ # reports][1].
6236
+ #
6237
+ # When using this parameter, your caller identity (the IAM role that
6238
+ # you're using DataSync with) must have the `iam:PassRole`
6239
+ # permission. The [AWSDataSyncFullAccess][2] policy includes this
6240
+ # permission.
6241
+ #
6242
+ # To remove a task report configuration, specify this parameter as
6243
+ # empty.
6244
+ #
6245
+ #
6246
+ #
6247
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
6248
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
5909
6249
  # @return [Types::TaskReportConfig]
5910
6250
  #
5911
6251
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskRequest AWS API Documentation
@@ -5918,6 +6258,7 @@ module Aws::DataSync
5918
6258
  :name,
5919
6259
  :cloud_watch_log_group_arn,
5920
6260
  :includes,
6261
+ :manifest_config,
5921
6262
  :task_report_config)
5922
6263
  SENSITIVE = []
5923
6264
  include Aws::Structure