aws-sdk-datasync 1.71.0 → 1.73.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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].
1083
1094
  #
1084
- # For detailed information about using such a role, see Creating a
1085
- # Location for Amazon S3 in the *DataSync User Guide*.
1095
+ #
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.
1185
+ # Specifies the name of the Active Directory domain that your SMB file
1186
+ # server belongs to.
1177
1187
  #
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
- #
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
@@ -1318,9 +1321,38 @@ module Aws::DataSync
1318
1321
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
1319
1322
  # @return [Array<Types::FilterRule>]
1320
1323
  #
1324
+ # @!attribute [rw] manifest_config
1325
+ # Configures a manifest, which is a list of files or objects that you
1326
+ # want DataSync to transfer. For more information and configuration
1327
+ # examples, see [Specifying what DataSync transfers by using a
1328
+ # manifest][1].
1329
+ #
1330
+ # When using this parameter, your caller identity (the role that
1331
+ # you're using DataSync with) must have the `iam:PassRole`
1332
+ # permission. The [AWSDataSyncFullAccess][2] policy includes this
1333
+ # permission.
1334
+ #
1335
+ #
1336
+ #
1337
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
1338
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
1339
+ # @return [Types::ManifestConfig]
1340
+ #
1321
1341
  # @!attribute [rw] task_report_config
1322
1342
  # Specifies how you want to configure a task report, which provides
1323
- # detailed information about for your DataSync transfer.
1343
+ # detailed information about your DataSync transfer. For more
1344
+ # information, see [Monitoring your DataSync transfers with task
1345
+ # reports][1].
1346
+ #
1347
+ # When using this parameter, your caller identity (the role that
1348
+ # you're using DataSync with) must have the `iam:PassRole`
1349
+ # permission. The [AWSDataSyncFullAccess][2] policy includes this
1350
+ # permission.
1351
+ #
1352
+ #
1353
+ #
1354
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
1355
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
1324
1356
  # @return [Types::TaskReportConfig]
1325
1357
  #
1326
1358
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTaskRequest AWS API Documentation
@@ -1335,6 +1367,7 @@ module Aws::DataSync
1335
1367
  :schedule,
1336
1368
  :tags,
1337
1369
  :includes,
1370
+ :manifest_config,
1338
1371
  :task_report_config)
1339
1372
  SENSITIVE = []
1340
1373
  include Aws::Structure
@@ -1876,8 +1909,8 @@ module Aws::DataSync
1876
1909
  end
1877
1910
 
1878
1911
  # @!attribute [rw] location_arn
1879
- # The Amazon Resource Name (ARN) of the FSx for Windows File Server
1880
- # location to describe.
1912
+ # Specifies the Amazon Resource Name (ARN) of the FSx for Windows File
1913
+ # Server location.
1881
1914
  # @return [String]
1882
1915
  #
1883
1916
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxWindowsRequest AWS API Documentation
@@ -1889,18 +1922,17 @@ module Aws::DataSync
1889
1922
  end
1890
1923
 
1891
1924
  # @!attribute [rw] location_arn
1892
- # The Amazon Resource Name (ARN) of the FSx for Windows File Server
1893
- # location that was described.
1925
+ # The ARN of the FSx for Windows File Server location.
1894
1926
  # @return [String]
1895
1927
  #
1896
1928
  # @!attribute [rw] location_uri
1897
- # The URL of the FSx for Windows File Server location that was
1898
- # described.
1929
+ # The uniform resource identifier (URI) of the FSx for Windows File
1930
+ # Server location.
1899
1931
  # @return [String]
1900
1932
  #
1901
1933
  # @!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.
1934
+ # The ARNs of the security groups that are configured for the FSx for
1935
+ # Windows File Server file system.
1904
1936
  # @return [Array<String>]
1905
1937
  #
1906
1938
  # @!attribute [rw] creation_time
@@ -1908,13 +1940,13 @@ module Aws::DataSync
1908
1940
  # @return [Time]
1909
1941
  #
1910
1942
  # @!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.
1943
+ # The user with the permissions to mount and access the FSx for
1944
+ # Windows File Server file system.
1913
1945
  # @return [String]
1914
1946
  #
1915
1947
  # @!attribute [rw] domain
1916
- # The name of the Windows domain that the FSx for Windows File Server
1917
- # belongs to.
1948
+ # The name of the Microsoft Active Directory domain that the FSx for
1949
+ # Windows File Server file system belongs to.
1918
1950
  # @return [String]
1919
1951
  #
1920
1952
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxWindowsResponse AWS API Documentation
@@ -1931,8 +1963,7 @@ module Aws::DataSync
1931
1963
  end
1932
1964
 
1933
1965
  # @!attribute [rw] location_arn
1934
- # The Amazon Resource Name (ARN) of the HDFS cluster location to
1935
- # describe.
1966
+ # Specifies the Amazon Resource Name (ARN) of the HDFS location.
1936
1967
  # @return [String]
1937
1968
  #
1938
1969
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationHdfsRequest AWS API Documentation
@@ -1944,15 +1975,15 @@ module Aws::DataSync
1944
1975
  end
1945
1976
 
1946
1977
  # @!attribute [rw] location_arn
1947
- # The ARN of the HDFS cluster location.
1978
+ # The ARN of the HDFS location.
1948
1979
  # @return [String]
1949
1980
  #
1950
1981
  # @!attribute [rw] location_uri
1951
- # The URI of the HDFS cluster location.
1982
+ # The URI of the HDFS location.
1952
1983
  # @return [String]
1953
1984
  #
1954
1985
  # @!attribute [rw] name_nodes
1955
- # The NameNode that manage the HDFS namespace.
1986
+ # The NameNode that manages the HDFS namespace.
1956
1987
  # @return [Array<Types::HdfsNameNode>]
1957
1988
  #
1958
1989
  # @!attribute [rw] block_size
@@ -1969,9 +2000,9 @@ module Aws::DataSync
1969
2000
  # @return [String]
1970
2001
  #
1971
2002
  # @!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.
2003
+ # The Quality of Protection (QOP) configuration, which specifies the
2004
+ # Remote Procedure Call (RPC) and data transfer protection settings
2005
+ # configured on the HDFS cluster.
1975
2006
  # @return [Types::QopConfiguration]
1976
2007
  #
1977
2008
  # @!attribute [rw] authentication_type
@@ -1980,9 +2011,9 @@ module Aws::DataSync
1980
2011
  # @return [String]
1981
2012
  #
1982
2013
  # @!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`.
2014
+ # The user name to identify the client on the host operating system.
2015
+ # This parameter is used if the `AuthenticationType` is defined as
2016
+ # `SIMPLE`.
1986
2017
  # @return [String]
1987
2018
  #
1988
2019
  # @!attribute [rw] kerberos_principal
@@ -1992,7 +2023,8 @@ module Aws::DataSync
1992
2023
  # @return [String]
1993
2024
  #
1994
2025
  # @!attribute [rw] agent_arns
1995
- # The ARNs of the agents that are used to connect to the HDFS cluster.
2026
+ # The ARNs of the DataSync agents that can connect with your HDFS
2027
+ # cluster.
1996
2028
  # @return [Array<String>]
1997
2029
  #
1998
2030
  # @!attribute [rw] creation_time
@@ -2040,7 +2072,7 @@ module Aws::DataSync
2040
2072
  # @return [String]
2041
2073
  #
2042
2074
  # @!attribute [rw] location_uri
2043
- # The URL of the NFS location.
2075
+ # The URI of the NFS location.
2044
2076
  # @return [String]
2045
2077
  #
2046
2078
  # @!attribute [rw] on_prem_config
@@ -2071,8 +2103,8 @@ module Aws::DataSync
2071
2103
  # DescribeLocationObjectStorageRequest
2072
2104
  #
2073
2105
  # @!attribute [rw] location_arn
2074
- # The Amazon Resource Name (ARN) of the object storage system location
2075
- # that you want information about.
2106
+ # Specifies the Amazon Resource Name (ARN) of the object storage
2107
+ # system location.
2076
2108
  # @return [String]
2077
2109
  #
2078
2110
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationObjectStorageRequest AWS API Documentation
@@ -2090,7 +2122,7 @@ module Aws::DataSync
2090
2122
  # @return [String]
2091
2123
  #
2092
2124
  # @!attribute [rw] location_uri
2093
- # The URL of the object storage system location.
2125
+ # The URI of the object storage system location.
2094
2126
  # @return [String]
2095
2127
  #
2096
2128
  # @!attribute [rw] access_key
@@ -2108,8 +2140,8 @@ module Aws::DataSync
2108
2140
  # @return [String]
2109
2141
  #
2110
2142
  # @!attribute [rw] agent_arns
2111
- # The ARNs of the DataSync agents that can securely connect with your
2112
- # location.
2143
+ # The ARNs of the DataSync agents that can connect with your object
2144
+ # storage system.
2113
2145
  # @return [Array<String>]
2114
2146
  #
2115
2147
  # @!attribute [rw] creation_time
@@ -2139,8 +2171,7 @@ module Aws::DataSync
2139
2171
  # DescribeLocationS3Request
2140
2172
  #
2141
2173
  # @!attribute [rw] location_arn
2142
- # The Amazon Resource Name (ARN) of the Amazon S3 bucket location to
2143
- # describe.
2174
+ # Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.
2144
2175
  # @return [String]
2145
2176
  #
2146
2177
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationS3Request AWS API Documentation
@@ -2154,8 +2185,7 @@ module Aws::DataSync
2154
2185
  # DescribeLocationS3Response
2155
2186
  #
2156
2187
  # @!attribute [rw] location_arn
2157
- # The Amazon Resource Name (ARN) of the Amazon S3 bucket or access
2158
- # point.
2188
+ # The ARN of the Amazon S3 location.
2159
2189
  # @return [String]
2160
2190
  #
2161
2191
  # @!attribute [rw] location_uri
@@ -2163,32 +2193,34 @@ module Aws::DataSync
2163
2193
  # @return [String]
2164
2194
  #
2165
2195
  # @!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].
2196
+ # When Amazon S3 is a destination location, this is the storage class
2197
+ # that you chose for your objects.
2172
2198
  #
2199
+ # Some storage classes have behaviors that can affect your Amazon S3
2200
+ # storage costs. For more information, see [Storage class
2201
+ # considerations with Amazon S3 transfers][1].
2173
2202
  #
2174
2203
  #
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
2204
+ #
2205
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
2177
2206
  # @return [String]
2178
2207
  #
2179
2208
  # @!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.
2209
+ # Specifies the Amazon Resource Name (ARN) of the Identity and Access
2210
+ # Management (IAM) role that DataSync uses to access your S3 bucket.
2211
+ #
2212
+ # For more information, see [Accessing S3 buckets][1].
2213
+ #
2182
2214
  #
2183
- # For detailed information about using such a role, see Creating a
2184
- # Location for Amazon S3 in the *DataSync User Guide*.
2215
+ #
2216
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access
2185
2217
  # @return [Types::S3Config]
2186
2218
  #
2187
2219
  # @!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
2220
+ # The ARNs of the DataSync agents deployed on your Outpost when using
2221
+ # working with Amazon S3 on Outposts.
2222
+ #
2223
+ # For more information, see [Deploy your DataSync agent on
2192
2224
  # Outposts][1].
2193
2225
  #
2194
2226
  #
@@ -2197,7 +2229,7 @@ module Aws::DataSync
2197
2229
  # @return [Array<String>]
2198
2230
  #
2199
2231
  # @!attribute [rw] creation_time
2200
- # The time that the Amazon S3 bucket location was created.
2232
+ # The time that the Amazon S3 location was created.
2201
2233
  # @return [Time]
2202
2234
  #
2203
2235
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationS3Response AWS API Documentation
@@ -2216,7 +2248,8 @@ module Aws::DataSync
2216
2248
  # DescribeLocationSmbRequest
2217
2249
  #
2218
2250
  # @!attribute [rw] location_arn
2219
- # The Amazon Resource Name (ARN) of the SMB location to describe.
2251
+ # Specifies the Amazon Resource Name (ARN) of the SMB location that
2252
+ # you want information about.
2220
2253
  # @return [String]
2221
2254
  #
2222
2255
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationSmbRequest AWS API Documentation
@@ -2230,31 +2263,30 @@ module Aws::DataSync
2230
2263
  # DescribeLocationSmbResponse
2231
2264
  #
2232
2265
  # @!attribute [rw] location_arn
2233
- # The Amazon Resource Name (ARN) of the SMB location that was
2234
- # described.
2266
+ # The ARN of the SMB location.
2235
2267
  # @return [String]
2236
2268
  #
2237
2269
  # @!attribute [rw] location_uri
2238
- # The URL of the source SMB location that was described.
2270
+ # The URI of the SMB location.
2239
2271
  # @return [String]
2240
2272
  #
2241
2273
  # @!attribute [rw] agent_arns
2242
- # The Amazon Resource Name (ARN) of the source SMB file system
2243
- # location that is created.
2274
+ # The ARNs of the DataSync agents that can connect with your SMB file
2275
+ # server.
2244
2276
  # @return [Array<String>]
2245
2277
  #
2246
2278
  # @!attribute [rw] user
2247
- # The user who can mount the share, has the permissions to access
2248
- # files and folders in the SMB share.
2279
+ # The user that can mount and access the files, folders, and file
2280
+ # metadata in your SMB file server.
2249
2281
  # @return [String]
2250
2282
  #
2251
2283
  # @!attribute [rw] domain
2252
- # The name of the Windows domain that the SMB server belongs to.
2284
+ # The name of the Microsoft Active Directory domain that the SMB file
2285
+ # server belongs to.
2253
2286
  # @return [String]
2254
2287
  #
2255
2288
  # @!attribute [rw] mount_options
2256
- # The mount options that are available for DataSync to use to access
2257
- # an SMB location.
2289
+ # The protocol that DataSync use to access your SMB file.
2258
2290
  # @return [Types::SmbMountOptions]
2259
2291
  #
2260
2292
  # @!attribute [rw] creation_time
@@ -2571,6 +2603,16 @@ module Aws::DataSync
2571
2603
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
2572
2604
  # @return [Array<Types::FilterRule>]
2573
2605
  #
2606
+ # @!attribute [rw] manifest_config
2607
+ # The configuration of the manifest that lists the files or objects to
2608
+ # transfer. For more information, see [Specifying what DataSync
2609
+ # transfers by using a manifest][1].
2610
+ #
2611
+ #
2612
+ #
2613
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
2614
+ # @return [Types::ManifestConfig]
2615
+ #
2574
2616
  # @!attribute [rw] start_time
2575
2617
  # The time when the task execution started.
2576
2618
  # @return [Time]
@@ -2612,19 +2654,24 @@ module Aws::DataSync
2612
2654
  # number of bytes sent over the network, see `BytesCompressed`.
2613
2655
  # @return [Integer]
2614
2656
  #
2615
- # @!attribute [rw] result
2616
- # The result of the task execution.
2617
- # @return [Types::TaskExecutionResultDetail]
2618
- #
2619
2657
  # @!attribute [rw] bytes_compressed
2620
2658
  # The physical number of bytes transferred over the network after
2621
2659
  # compression was applied. In most cases, this number is less than
2622
2660
  # `BytesTransferred` unless the data isn't compressible.
2623
2661
  # @return [Integer]
2624
2662
  #
2663
+ # @!attribute [rw] result
2664
+ # The result of the task execution.
2665
+ # @return [Types::TaskExecutionResultDetail]
2666
+ #
2625
2667
  # @!attribute [rw] task_report_config
2626
2668
  # The configuration of your task report, which provides detailed
2627
- # information about for your DataSync transfer.
2669
+ # information about for your DataSync transfer. For more information,
2670
+ # see [Creating a task report][1].
2671
+ #
2672
+ #
2673
+ #
2674
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
2628
2675
  # @return [Types::TaskReportConfig]
2629
2676
  #
2630
2677
  # @!attribute [rw] files_deleted
@@ -2686,14 +2733,15 @@ module Aws::DataSync
2686
2733
  :options,
2687
2734
  :excludes,
2688
2735
  :includes,
2736
+ :manifest_config,
2689
2737
  :start_time,
2690
2738
  :estimated_files_to_transfer,
2691
2739
  :estimated_bytes_to_transfer,
2692
2740
  :files_transferred,
2693
2741
  :bytes_written,
2694
2742
  :bytes_transferred,
2695
- :result,
2696
2743
  :bytes_compressed,
2744
+ :result,
2697
2745
  :task_report_config,
2698
2746
  :files_deleted,
2699
2747
  :files_skipped,
@@ -2831,9 +2879,20 @@ module Aws::DataSync
2831
2879
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
2832
2880
  # @return [Array<Types::FilterRule>]
2833
2881
  #
2882
+ # @!attribute [rw] manifest_config
2883
+ # The configuration of the manifest that lists the files or objects to
2884
+ # transfer. For more information, see [Specifying what DataSync
2885
+ # transfers by using a manifest][1].
2886
+ #
2887
+ #
2888
+ #
2889
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
2890
+ # @return [Types::ManifestConfig]
2891
+ #
2834
2892
  # @!attribute [rw] task_report_config
2835
- # The configuration of your task report. For more information, see
2836
- # [Creating a task report][1].
2893
+ # The configuration of your task report, which provides detailed
2894
+ # information about for your DataSync transfer. For more information,
2895
+ # see [Creating a task report][1].
2837
2896
  #
2838
2897
  #
2839
2898
  #
@@ -2859,6 +2918,7 @@ module Aws::DataSync
2859
2918
  :error_detail,
2860
2919
  :creation_time,
2861
2920
  :includes,
2921
+ :manifest_config,
2862
2922
  :task_report_config)
2863
2923
  SENSITIVE = []
2864
2924
  include Aws::Structure
@@ -3022,6 +3082,9 @@ module Aws::DataSync
3022
3082
  # @!attribute [rw] domain
3023
3083
  # Specifies the fully qualified domain name (FQDN) of the Microsoft
3024
3084
  # Active Directory that your storage virtual machine (SVM) belongs to.
3085
+ #
3086
+ # If you have multiple domains in your environment, configuring this
3087
+ # setting makes sure that DataSync connects to the right SVM.
3025
3088
  # @return [String]
3026
3089
  #
3027
3090
  # @!attribute [rw] mount_options
@@ -3035,37 +3098,15 @@ module Aws::DataSync
3035
3098
  # @return [String]
3036
3099
  #
3037
3100
  # @!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).
3101
+ # Specifies a user that can mount and access the files, folders, and
3102
+ # metadata in your SVM.
3058
3103
  #
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].
3104
+ # For information about choosing a user with the right level of access
3105
+ # for your transfer, see [Using the SMB protocol][1].
3065
3106
  #
3066
3107
  #
3067
3108
  #
3068
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions
3109
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb
3069
3110
  # @return [String]
3070
3111
  #
3071
3112
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/FsxProtocolSmb AWS API Documentation
@@ -3449,17 +3490,17 @@ module Aws::DataSync
3449
3490
  # ListTaskExecutions
3450
3491
  #
3451
3492
  # @!attribute [rw] task_arn
3452
- # The Amazon Resource Name (ARN) of the task whose tasks you want to
3453
- # list.
3493
+ # Specifies the Amazon Resource Name (ARN) of the task that you want
3494
+ # execution information about.
3454
3495
  # @return [String]
3455
3496
  #
3456
3497
  # @!attribute [rw] max_results
3457
- # The maximum number of executed tasks to list.
3498
+ # Specifies how many results you want in the response.
3458
3499
  # @return [Integer]
3459
3500
  #
3460
3501
  # @!attribute [rw] next_token
3461
- # An opaque string that indicates the position at which to begin the
3462
- # next list of the executed tasks.
3502
+ # Specifies an opaque string that indicates the position at which to
3503
+ # begin the next list of results in the response.
3463
3504
  # @return [String]
3464
3505
  #
3465
3506
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTaskExecutionsRequest AWS API Documentation
@@ -3475,12 +3516,12 @@ module Aws::DataSync
3475
3516
  # ListTaskExecutionsResponse
3476
3517
  #
3477
3518
  # @!attribute [rw] task_executions
3478
- # A list of executed tasks.
3519
+ # A list of the task's executions.
3479
3520
  # @return [Array<Types::TaskExecutionListEntry>]
3480
3521
  #
3481
3522
  # @!attribute [rw] next_token
3482
- # An opaque string that indicates the position at which to begin
3483
- # returning the next list of executed tasks.
3523
+ # The opaque string that indicates the position to begin the next list
3524
+ # of results in the response.
3484
3525
  # @return [String]
3485
3526
  #
3486
3527
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTaskExecutionsResponse AWS API Documentation
@@ -3628,6 +3669,58 @@ module Aws::DataSync
3628
3669
  include Aws::Structure
3629
3670
  end
3630
3671
 
3672
+ # Configures a manifest, which is a list of files or objects that you
3673
+ # want DataSync to transfer. For more information and configuration
3674
+ # examples, see [Specifying what DataSync transfers by using a
3675
+ # manifest][1].
3676
+ #
3677
+ #
3678
+ #
3679
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
3680
+ #
3681
+ # @!attribute [rw] action
3682
+ # Specifies what DataSync uses the manifest for.
3683
+ # @return [String]
3684
+ #
3685
+ # @!attribute [rw] format
3686
+ # Specifies the file format of your manifest. For more information,
3687
+ # see [Creating a manifest][1].
3688
+ #
3689
+ #
3690
+ #
3691
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-create
3692
+ # @return [String]
3693
+ #
3694
+ # @!attribute [rw] source
3695
+ # Specifies the manifest that you want DataSync to use and where it's
3696
+ # hosted.
3697
+ #
3698
+ # <note markdown="1"> You must specify this parameter if you're configuring a new
3699
+ # manifest on or after February 7, 2024.
3700
+ #
3701
+ # If you don't, you'll get a 400 status code and
3702
+ # `ValidationException` error stating that you're missing the IAM
3703
+ # role for DataSync to access the S3 bucket where you're hosting your
3704
+ # manifest. For more information, see [Providing DataSync access to
3705
+ # your manifest][1].
3706
+ #
3707
+ # </note>
3708
+ #
3709
+ #
3710
+ #
3711
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access
3712
+ # @return [Types::SourceManifestConfig]
3713
+ #
3714
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ManifestConfig AWS API Documentation
3715
+ #
3716
+ class ManifestConfig < Struct.new(
3717
+ :action,
3718
+ :format,
3719
+ :source)
3720
+ SENSITIVE = []
3721
+ include Aws::Structure
3722
+ end
3723
+
3631
3724
  # The performance data that DataSync Discovery collects about an
3632
3725
  # on-premises storage system resource.
3633
3726
  #
@@ -4039,30 +4132,28 @@ module Aws::DataSync
4039
4132
  # Specifies how and when DataSync checks the integrity of your data
4040
4133
  # during a transfer.
4041
4134
  #
4042
- # Default value: `POINT_IN_TIME_CONSISTENT`
4135
+ # * `ONLY_FILES_TRANSFERRED` (recommended) - DataSync calculates the
4136
+ # checksum of transferred files and metadata at the source location.
4137
+ # At the end of the transfer, DataSync then compares this checksum
4138
+ # to the checksum calculated on those files at the destination.
4043
4139
  #
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.
4140
+ # We recommend this option when transferring to S3 Glacier Flexible
4141
+ # Retrieval or S3 Glacier Deep Archive storage classes. For more
4142
+ # information, see [Storage class considerations with Amazon S3
4143
+ # locations][1].
4048
4144
  #
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].
4145
+ # * `POINT_IN_TIME_CONSISTENT` (default) - At the end of the transfer,
4146
+ # DataSync scans the entire source and destination to verify that
4147
+ # both locations are fully synchronized.
4053
4148
  #
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.
4149
+ # You can't use this option when transferring to S3 Glacier
4150
+ # Flexible Retrieval or S3 Glacier Deep Archive storage classes. For
4151
+ # more information, see [Storage class considerations with Amazon S3
4152
+ # locations][1].
4057
4153
  #
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].
4062
- #
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.
4154
+ # * `NONE` - DataSync doesn't run additional verification at the end
4155
+ # of the transfer. All data transmissions are still
4156
+ # integrity-checked with checksum verification during the transfer.
4066
4157
  #
4067
4158
  #
4068
4159
  #
@@ -4070,17 +4161,21 @@ module Aws::DataSync
4070
4161
  # @return [String]
4071
4162
  #
4072
4163
  # @!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.
4164
+ # Specifies whether DataSync should modify or preserve data at the
4165
+ # destination location.
4166
+ #
4167
+ # * `ALWAYS` (default) - DataSync modifies data in the destination
4168
+ # location when source data (including metadata) has changed.
4169
+ #
4170
+ # If DataSync overwrites objects, you might incur additional charges
4171
+ # for certain Amazon S3 storage classes (for example, for retrieval
4172
+ # or early deletion). For more information, see [Storage class
4173
+ # considerations with Amazon S3 transfers][1].
4079
4174
  #
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].
4175
+ # * `NEVER` - DataSync doesn't overwrite data in the destination
4176
+ # location even if the source data has changed. You can use this
4177
+ # option to protect against overwriting changes made to files or
4178
+ # objects in the destination.
4084
4179
  #
4085
4180
  #
4086
4181
  #
@@ -4089,22 +4184,19 @@ module Aws::DataSync
4089
4184
  #
4090
4185
  # @!attribute [rw] atime
4091
4186
  # 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).
4187
+ # file was read or written to.
4096
4188
  #
4097
4189
  # <note markdown="1"> The behavior of `Atime` isn't fully standard across platforms, so
4098
4190
  # DataSync can only do this on a best-effort basis.
4099
4191
  #
4100
4192
  # </note>
4101
4193
  #
4102
- # Default value: `BEST_EFFORT`
4194
+ # * `BEST_EFFORT` (default) - DataSync attempts to preserve the
4195
+ # original `Atime` attribute on all source files (that is, the
4196
+ # version before the `PREPARING` phase of the task execution). This
4197
+ # option is recommended.
4103
4198
  #
4104
- # `BEST_EFFORT`: Attempt to preserve the per-file `Atime` value
4105
- # (recommended).
4106
- #
4107
- # `NONE`: Ignore `Atime`.
4199
+ # * `NONE` - Ignores `Atime`.
4108
4200
  #
4109
4201
  # <note markdown="1"> If `Atime` is set to `BEST_EFFORT`, `Mtime` must be set to
4110
4202
  # `PRESERVE`.
@@ -4120,11 +4212,10 @@ module Aws::DataSync
4120
4212
  # execution. This option is required when you need to run the a task
4121
4213
  # more than once.
4122
4214
  #
4123
- # Default Value: `PRESERVE`
4124
- #
4125
- # `PRESERVE`: Preserve original `Mtime` (recommended)
4215
+ # * `PRESERVE` (default) - Preserves original `Mtime`, which is
4216
+ # recommended.
4126
4217
  #
4127
- # `NONE`: Ignore `Mtime`.
4218
+ # * `NONE` - Ignores `Mtime`.
4128
4219
  #
4129
4220
  # <note markdown="1"> If `Mtime` is set to `PRESERVE`, `Atime` must be set to
4130
4221
  # `BEST_EFFORT`.
@@ -4137,15 +4228,12 @@ module Aws::DataSync
4137
4228
  # @!attribute [rw] uid
4138
4229
  # Specifies the POSIX user ID (UID) of the file's owner.
4139
4230
  #
4140
- # For more information, see [Metadata copied by DataSync][1].
4231
+ # * `INT_VALUE` (default) - Preserves the integer value of UID and
4232
+ # group ID (GID), which is recommended.
4141
4233
  #
4142
- # Default value: `INT_VALUE`. This preserves the integer value of the
4143
- # ID.
4234
+ # * `NONE` - Ignores UID and GID.
4144
4235
  #
4145
- # `INT_VALUE`: Preserve the integer value of UID and group ID (GID)
4146
- # (recommended).
4147
- #
4148
- # `NONE`: Ignore UID and GID.
4236
+ # For more information, see [Metadata copied by DataSync][1].
4149
4237
  #
4150
4238
  #
4151
4239
  #
@@ -4155,15 +4243,12 @@ module Aws::DataSync
4155
4243
  # @!attribute [rw] gid
4156
4244
  # Specifies the POSIX group ID (GID) of the file's owners.
4157
4245
  #
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.
4246
+ # * `INT_VALUE` (default) - Preserves the integer value of user ID
4247
+ # (UID) and GID, which is recommended.
4162
4248
  #
4163
- # `INT_VALUE`: Preserve the integer value of user ID (UID) and GID
4164
- # (recommended).
4249
+ # * `NONE` - Ignores UID and GID.
4165
4250
  #
4166
- # `NONE`: Ignore UID and GID.
4251
+ # For more information, see [Metadata copied by DataSync][1].
4167
4252
  #
4168
4253
  #
4169
4254
  #
@@ -4178,12 +4263,11 @@ module Aws::DataSync
4178
4263
  # For detailed information, see [Considerations when working with
4179
4264
  # Amazon S3 storage classes in DataSync][1].
4180
4265
  #
4181
- # Default value: `PRESERVE`
4182
- #
4183
- # `PRESERVE`: Ignore such destination files (recommended).
4266
+ # * `PRESERVE` (default) - Ignores such destination files, which is
4267
+ # recommended.
4184
4268
  #
4185
- # `REMOVE`: Delete destination files that aren’t present in the
4186
- # source.
4269
+ # * `REMOVE` - Deletes destination files that aren’t present in the
4270
+ # source.
4187
4271
  #
4188
4272
  # <note markdown="1"> If you set this parameter to `REMOVE`, you can't set `TransferMode`
4189
4273
  # to `ALL`. When you transfer all data, DataSync doesn't scan your
@@ -4207,12 +4291,10 @@ module Aws::DataSync
4207
4291
  #
4208
4292
  # </note>
4209
4293
  #
4210
- # Default value: `NONE`
4294
+ # * `NONE` (default) - Ignores special devices (recommended).
4211
4295
  #
4212
- # `NONE`: Ignore special devices (recommended).
4213
- #
4214
- # `PRESERVE`: Preserve character and block device metadata. This
4215
- # option currently isn't supported for Amazon EFS.
4296
+ # * `PRESERVE` - Preserves character and block device metadata. This
4297
+ # option currently isn't supported for Amazon EFS.
4216
4298
  # @return [String]
4217
4299
  #
4218
4300
  # @!attribute [rw] posix_permissions
@@ -4221,11 +4303,10 @@ module Aws::DataSync
4221
4303
  #
4222
4304
  # For more information, see [Metadata copied by DataSync][1].
4223
4305
  #
4224
- # Default value: `PRESERVE`
4225
- #
4226
- # `PRESERVE`: Preserve POSIX-style permissions (recommended).
4306
+ # * `PRESERVE` (default) - Preserves POSIX-style permissions, which is
4307
+ # recommended.
4227
4308
  #
4228
- # `NONE`: Ignore permissions.
4309
+ # * `NONE` - Ignores POSIX-style permissions.
4229
4310
  #
4230
4311
  # <note markdown="1"> DataSync can preserve extant permissions of a source location.
4231
4312
  #
@@ -4257,10 +4338,13 @@ module Aws::DataSync
4257
4338
  # CloudWatch Logs log group. To specify the log group, see
4258
4339
  # [CloudWatchLogGroupArn][1].
4259
4340
  #
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.
4341
+ # * `BASIC` - Publishes logs with only basic information (such as
4342
+ # transfer errors).
4343
+ #
4344
+ # * `TRANSFER` - Publishes logs for all files or objects that your
4345
+ # DataSync task transfers and performs data-integrity checks on.
4346
+ #
4347
+ # * `OFF` - No logs are published.
4264
4348
  #
4265
4349
  #
4266
4350
  #
@@ -4273,12 +4357,12 @@ module Aws::DataSync
4273
4357
  # transfers all the content from the source (without comparing what's
4274
4358
  # in the destination).
4275
4359
  #
4276
- # `CHANGED`: DataSync copies only data or metadata that is new or
4277
- # different content from the source location to the destination
4278
- # location.
4360
+ # * `CHANGED` (default) - DataSync copies only data or metadata that
4361
+ # is new or different content from the source location to the
4362
+ # destination location.
4279
4363
  #
4280
- # `ALL`: DataSync copies all source location content to the
4281
- # destination (without comparing what's in the destination).
4364
+ # * `ALL` - DataSync copies everything in the source to the
4365
+ # destination without comparing differences between the locations.
4282
4366
  # @return [String]
4283
4367
  #
4284
4368
  # @!attribute [rw] security_descriptor_copy_flags
@@ -4290,52 +4374,53 @@ module Aws::DataSync
4290
4374
  # Server locations. For more information, see [how DataSync handles
4291
4375
  # metadata][1].
4292
4376
  #
4293
- # Default value: `OWNER_DACL`
4294
- #
4295
- # `OWNER_DACL`: For each copied object, DataSync copies the following
4296
- # metadata:
4377
+ # * `OWNER_DACL` (default) - For each copied object, DataSync copies
4378
+ # the following metadata:
4297
4379
  #
4298
- # * The object owner.
4380
+ # * The object owner.
4299
4381
  #
4300
- # * NTFS discretionary access control lists (DACLs), which determine
4301
- # whether to grant access to an object.
4382
+ # * NTFS discretionary access control lists (DACLs), which determine
4383
+ # whether to grant access to an object.
4302
4384
  #
4303
- # DataSync won't copy NTFS system access control lists (SACLs) with
4304
- # this option.
4385
+ # DataSync won't copy NTFS system access control lists (SACLs)
4386
+ # with this option.
4305
4387
  #
4306
- # `OWNER_DACL_SACL`: For each copied object, DataSync copies the
4307
- # following metadata:
4388
+ # * `OWNER_DACL_SACL` - For each copied object, DataSync copies the
4389
+ # following metadata:
4308
4390
  #
4309
- # * The object owner.
4391
+ # * The object owner.
4310
4392
  #
4311
- # * NTFS discretionary access control lists (DACLs), which determine
4312
- # whether to grant access to an object.
4393
+ # * NTFS discretionary access control lists (DACLs), which determine
4394
+ # whether to grant access to an object.
4313
4395
  #
4314
- # * SACLs, which are used by administrators to log attempts to access
4315
- # a secured object.
4396
+ # * SACLs, which are used by administrators to log attempts to
4397
+ # access a secured object.
4316
4398
  #
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).
4399
+ # Copying SACLs requires granting additional permissions to the
4400
+ # Windows user that DataSync uses to access your SMB location. For
4401
+ # information about choosing a user with the right permissions,
4402
+ # see required permissions for [SMB][2], [FSx for Windows File
4403
+ # Server][3], or [FSx for ONTAP][4] (depending on the type of
4404
+ # location in your transfer).
4322
4405
  #
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.
4406
+ # * `NONE` - None of the SMB security descriptor components are
4407
+ # copied. Destination objects are owned by the user that was
4408
+ # provided for accessing the destination location. DACLs and SACLs
4409
+ # are set based on the destination server’s configuration.
4327
4410
  #
4328
4411
  #
4329
4412
  #
4330
4413
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html
4414
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
4415
+ # [3]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions
4416
+ # [4]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb
4331
4417
  # @return [String]
4332
4418
  #
4333
4419
  # @!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`
4420
+ # Specifies whether you want DataSync to `PRESERVE` object tags
4421
+ # (default behavior) when transferring between object storage systems.
4422
+ # If you want your DataSync task to ignore object tags, specify the
4423
+ # `NONE` value.
4339
4424
  # @return [String]
4340
4425
  #
4341
4426
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Options AWS API Documentation
@@ -4397,16 +4482,17 @@ module Aws::DataSync
4397
4482
  # @!attribute [rw] version
4398
4483
  # The version of the DataSync agent.
4399
4484
  #
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].
4485
+ # On December 7, 2023, we discontinued version 1 DataSync agents.
4486
+ # Check the DataSync console to see if you have affected agents. If
4487
+ # you do, [replace][1] those agents or [delete][2] them if they
4488
+ # aren't in use. If you need more help, contact [Amazon Web Services
4489
+ # Support][3].
4405
4490
  #
4406
4491
  #
4407
4492
  #
4408
4493
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html
4409
- # [2]: https://aws.amazon.com/contact-us/
4494
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/deleting-agent.html
4495
+ # [3]: https://aws.amazon.com/contact-us/
4410
4496
  # @return [String]
4411
4497
  #
4412
4498
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Platform AWS API Documentation
@@ -4582,7 +4668,7 @@ module Aws::DataSync
4582
4668
  #
4583
4669
  #
4584
4670
  #
4585
- # [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
4671
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
4586
4672
  # @return [String]
4587
4673
  #
4588
4674
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ReportDestinationS3 AWS API Documentation
@@ -4769,14 +4855,18 @@ module Aws::DataSync
4769
4855
  include Aws::Structure
4770
4856
  end
4771
4857
 
4772
- # The Amazon Resource Name (ARN) of the Identity and Access Management
4773
- # (IAM) role used to access an Amazon S3 bucket.
4858
+ # Specifies the Amazon Resource Name (ARN) of the Identity and Access
4859
+ # Management (IAM) role that DataSync uses to access your S3 bucket.
4860
+ #
4861
+ # For more information, see [Accessing S3 buckets][1].
4774
4862
  #
4775
- # For detailed information about using such a role, see Creating a
4776
- # Location for Amazon S3 in the *DataSync User Guide*.
4863
+ #
4864
+ #
4865
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access
4777
4866
  #
4778
4867
  # @!attribute [rw] bucket_access_role_arn
4779
- # The ARN of the IAM role for accessing the S3 bucket.
4868
+ # Specifies the ARN of the IAM role that DataSync uses to access your
4869
+ # S3 bucket.
4780
4870
  # @return [String]
4781
4871
  #
4782
4872
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/S3Config AWS API Documentation
@@ -4787,6 +4877,51 @@ module Aws::DataSync
4787
4877
  include Aws::Structure
4788
4878
  end
4789
4879
 
4880
+ # Specifies the S3 bucket where you're hosting the manifest that you
4881
+ # want DataSync to use. For more information and configuration examples,
4882
+ # see [Specifying what DataSync transfers by using a manifest][1].
4883
+ #
4884
+ #
4885
+ #
4886
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
4887
+ #
4888
+ # @!attribute [rw] manifest_object_path
4889
+ # Specifies the Amazon S3 object key of your manifest. This can
4890
+ # include a prefix (for example, `prefix/my-manifest.csv`).
4891
+ # @return [String]
4892
+ #
4893
+ # @!attribute [rw] bucket_access_role_arn
4894
+ # Specifies the Identity and Access Management (IAM) role that allows
4895
+ # DataSync to access your manifest. For more information, see
4896
+ # [Providing DataSync access to your manifest][1].
4897
+ #
4898
+ #
4899
+ #
4900
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access
4901
+ # @return [String]
4902
+ #
4903
+ # @!attribute [rw] s3_bucket_arn
4904
+ # Specifies the Amazon Resource Name (ARN) of the S3 bucket where
4905
+ # you're hosting your manifest.
4906
+ # @return [String]
4907
+ #
4908
+ # @!attribute [rw] manifest_object_version_id
4909
+ # Specifies the object version ID of the manifest that you want
4910
+ # DataSync to use. If you don't set this, DataSync uses the latest
4911
+ # version of the object.
4912
+ # @return [String]
4913
+ #
4914
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/S3ManifestConfig AWS API Documentation
4915
+ #
4916
+ class S3ManifestConfig < Struct.new(
4917
+ :manifest_object_path,
4918
+ :bucket_access_role_arn,
4919
+ :s3_bucket_arn,
4920
+ :manifest_object_version_id)
4921
+ SENSITIVE = []
4922
+ include Aws::Structure
4923
+ end
4924
+
4790
4925
  # Specifies the version of the Server Message Block (SMB) protocol that
4791
4926
  # DataSync uses to access an SMB file server.
4792
4927
  #
@@ -4837,6 +4972,26 @@ module Aws::DataSync
4837
4972
  include Aws::Structure
4838
4973
  end
4839
4974
 
4975
+ # Specifies the manifest that you want DataSync to use and where it's
4976
+ # hosted. For more information and configuration examples, see
4977
+ # [Specifying what DataSync transfers by using a manifest][1].
4978
+ #
4979
+ #
4980
+ #
4981
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
4982
+ #
4983
+ # @!attribute [rw] s3
4984
+ # Specifies the S3 bucket where you're hosting your manifest.
4985
+ # @return [Types::S3ManifestConfig]
4986
+ #
4987
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/SourceManifestConfig AWS API Documentation
4988
+ #
4989
+ class SourceManifestConfig < Struct.new(
4990
+ :s3)
4991
+ SENSITIVE = []
4992
+ include Aws::Structure
4993
+ end
4994
+
4840
4995
  # @!attribute [rw] storage_system_arn
4841
4996
  # Specifies the Amazon Resource Name (ARN) of the on-premises storage
4842
4997
  # system that you want to run the discovery job on.
@@ -4923,6 +5078,46 @@ module Aws::DataSync
4923
5078
  # "\|" (that is, a pipe), for example, `"/folder1|/folder2"`.
4924
5079
  # @return [Array<Types::FilterRule>]
4925
5080
  #
5081
+ # @!attribute [rw] manifest_config
5082
+ # Configures a manifest, which is a list of files or objects that you
5083
+ # want DataSync to transfer. For more information and configuration
5084
+ # examples, see [Specifying what DataSync transfers by using a
5085
+ # manifest][1].
5086
+ #
5087
+ # When using this parameter, your caller identity (the role that
5088
+ # you're using DataSync with) must have the `iam:PassRole`
5089
+ # permission. The [AWSDataSyncFullAccess][2] policy includes this
5090
+ # permission.
5091
+ #
5092
+ # To remove a manifest configuration, specify this parameter with an
5093
+ # empty value.
5094
+ #
5095
+ #
5096
+ #
5097
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
5098
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
5099
+ # @return [Types::ManifestConfig]
5100
+ #
5101
+ # @!attribute [rw] task_report_config
5102
+ # Specifies how you want to configure a task report, which provides
5103
+ # detailed information about your DataSync transfer. For more
5104
+ # information, see [Monitoring your DataSync transfers with task
5105
+ # reports][1].
5106
+ #
5107
+ # When using this parameter, your caller identity (the role that
5108
+ # you're using DataSync with) must have the `iam:PassRole`
5109
+ # permission. The [AWSDataSyncFullAccess][2] policy includes this
5110
+ # permission.
5111
+ #
5112
+ # To remove a task report configuration, specify this parameter as
5113
+ # empty.
5114
+ #
5115
+ #
5116
+ #
5117
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
5118
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
5119
+ # @return [Types::TaskReportConfig]
5120
+ #
4926
5121
  # @!attribute [rw] tags
4927
5122
  # Specifies the tags that you want to apply to the Amazon Resource
4928
5123
  # Name (ARN) representing the task execution.
@@ -4931,11 +5126,6 @@ module Aws::DataSync
4931
5126
  # for your DataSync resources.
4932
5127
  # @return [Array<Types::TagListEntry>]
4933
5128
  #
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
5129
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartTaskExecutionRequest AWS API Documentation
4940
5130
  #
4941
5131
  class StartTaskExecutionRequest < Struct.new(
@@ -4943,8 +5133,9 @@ module Aws::DataSync
4943
5133
  :override_options,
4944
5134
  :includes,
4945
5135
  :excludes,
4946
- :tags,
4947
- :task_report_config)
5136
+ :manifest_config,
5137
+ :task_report_config,
5138
+ :tags)
4948
5139
  SENSITIVE = []
4949
5140
  include Aws::Structure
4950
5141
  end
@@ -5046,21 +5237,24 @@ module Aws::DataSync
5046
5237
  #
5047
5238
  class TagResourceResponse < Aws::EmptyStructure; end
5048
5239
 
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.
5240
+ # Represents a single entry in a list of DataSync task executions
5241
+ # that's returned with the [ListTaskExecutions][1] operation.
5053
5242
  #
5054
5243
  #
5055
5244
  #
5056
5245
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html
5057
5246
  #
5058
5247
  # @!attribute [rw] task_execution_arn
5059
- # The Amazon Resource Name (ARN) of the task that was executed.
5248
+ # The Amazon Resource Name (ARN) of a task execution.
5060
5249
  # @return [String]
5061
5250
  #
5062
5251
  # @!attribute [rw] status
5063
- # The status of a task execution.
5252
+ # The status of a task execution. For more information, see [Task
5253
+ # execution statuses][1].
5254
+ #
5255
+ #
5256
+ #
5257
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-execution-statuses
5064
5258
  # @return [String]
5065
5259
  #
5066
5260
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskExecutionListEntry AWS API Documentation
@@ -5903,9 +6097,43 @@ module Aws::DataSync
5903
6097
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
5904
6098
  # @return [Array<Types::FilterRule>]
5905
6099
  #
6100
+ # @!attribute [rw] manifest_config
6101
+ # Configures a manifest, which is a list of files or objects that you
6102
+ # want DataSync to transfer. For more information and configuration
6103
+ # examples, see [Specifying what DataSync transfers by using a
6104
+ # manifest][1].
6105
+ #
6106
+ # When using this parameter, your caller identity (the IAM role that
6107
+ # you're using DataSync with) must have the `iam:PassRole`
6108
+ # permission. The [AWSDataSyncFullAccess][2] policy includes this
6109
+ # permission.
6110
+ #
6111
+ # To remove a manifest configuration, specify this parameter as empty.
6112
+ #
6113
+ #
6114
+ #
6115
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
6116
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
6117
+ # @return [Types::ManifestConfig]
6118
+ #
5906
6119
  # @!attribute [rw] task_report_config
5907
6120
  # Specifies how you want to configure a task report, which provides
5908
- # detailed information about for your DataSync transfer.
6121
+ # detailed information about your DataSync transfer. For more
6122
+ # information, see [Monitoring your DataSync transfers with task
6123
+ # reports][1].
6124
+ #
6125
+ # When using this parameter, your caller identity (the IAM role that
6126
+ # you're using DataSync with) must have the `iam:PassRole`
6127
+ # permission. The [AWSDataSyncFullAccess][2] policy includes this
6128
+ # permission.
6129
+ #
6130
+ # To remove a task report configuration, specify this parameter as
6131
+ # empty.
6132
+ #
6133
+ #
6134
+ #
6135
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
6136
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
5909
6137
  # @return [Types::TaskReportConfig]
5910
6138
  #
5911
6139
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskRequest AWS API Documentation
@@ -5918,6 +6146,7 @@ module Aws::DataSync
5918
6146
  :name,
5919
6147
  :cloud_watch_log_group_arn,
5920
6148
  :includes,
6149
+ :manifest_config,
5921
6150
  :task_report_config)
5922
6151
  SENSITIVE = []
5923
6152
  include Aws::Structure