@aws-sdk/client-datasync 3.231.0 → 3.234.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.
- package/dist-cjs/endpoint/ruleset.js +1 -10
- package/dist-cjs/models/models_0.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +1 -0
- package/dist-es/endpoint/ruleset.js +1 -10
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +1 -0
- package/dist-types/DataSync.d.ts +9 -36
- package/dist-types/DataSyncClient.d.ts +1 -2
- package/dist-types/commands/CreateAgentCommand.d.ts +0 -2
- package/dist-types/commands/CreateLocationS3Command.d.ts +0 -2
- package/dist-types/commands/CreateTaskCommand.d.ts +0 -16
- package/dist-types/commands/DeleteTaskCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/StartTaskExecutionCommand.d.ts +2 -9
- package/dist-types/commands/TagResourceCommand.d.ts +3 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTaskExecutionCommand.d.ts +0 -1
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +173 -245
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +7 -7
|
@@ -65,10 +65,8 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
65
65
|
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
66
66
|
}
|
|
67
67
|
/**
|
|
68
|
-
* <p>
|
|
69
|
-
*
|
|
70
|
-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTagsForResource.html">ListTagsForResource</a>
|
|
71
|
-
* operation is called.</p>
|
|
68
|
+
* <p>A key-value pair representing a single tag that's been applied to an Amazon Web Services
|
|
69
|
+
* resource.</p>
|
|
72
70
|
*/
|
|
73
71
|
export interface TagListEntry {
|
|
74
72
|
/**
|
|
@@ -92,8 +90,6 @@ export interface CreateAgentRequest {
|
|
|
92
90
|
* agent in the query string parameter <code>activationKey</code>. It might also include other
|
|
93
91
|
* activation-related parameters; however, these are merely defaults. The arguments you pass to
|
|
94
92
|
* this API call determine the actual configuration of your agent.</p>
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
93
|
* <p>For more information, see Activating an Agent in the <i>DataSync
|
|
98
94
|
* User Guide.</i>
|
|
99
95
|
* </p>
|
|
@@ -267,7 +263,6 @@ export declare enum NfsVersion {
|
|
|
267
263
|
export interface NfsMountOptions {
|
|
268
264
|
/**
|
|
269
265
|
* <p>Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.</p>
|
|
270
|
-
*
|
|
271
266
|
* <p>You can specify the following options:</p>
|
|
272
267
|
* <ul>
|
|
273
268
|
* <li>
|
|
@@ -709,7 +704,6 @@ export interface CreateLocationNfsRequest {
|
|
|
709
704
|
* files. For the agent to access directories, you must additionally enable all execute
|
|
710
705
|
* access.</p>
|
|
711
706
|
* <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p>
|
|
712
|
-
*
|
|
713
707
|
* <p>For information about NFS export configuration, see 18.7. The /etc/exports
|
|
714
708
|
* Configuration File in the Red Hat Enterprise Linux documentation.</p>
|
|
715
709
|
*/
|
|
@@ -816,7 +810,6 @@ export interface CreateLocationObjectStorageResponse {
|
|
|
816
810
|
/**
|
|
817
811
|
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access
|
|
818
812
|
* an Amazon S3 bucket.</p>
|
|
819
|
-
*
|
|
820
813
|
* <p>For detailed information about using such a role, see Creating a Location for
|
|
821
814
|
* Amazon S3 in the <i>DataSync User Guide</i>.</p>
|
|
822
815
|
*/
|
|
@@ -829,6 +822,7 @@ export interface S3Config {
|
|
|
829
822
|
export declare enum S3StorageClass {
|
|
830
823
|
DEEP_ARCHIVE = "DEEP_ARCHIVE",
|
|
831
824
|
GLACIER = "GLACIER",
|
|
825
|
+
GLACIER_INSTANT_RETRIEVAL = "GLACIER_INSTANT_RETRIEVAL",
|
|
832
826
|
INTELLIGENT_TIERING = "INTELLIGENT_TIERING",
|
|
833
827
|
ONEZONE_IA = "ONEZONE_IA",
|
|
834
828
|
OUTPOSTS = "OUTPOSTS",
|
|
@@ -853,7 +847,6 @@ export interface CreateLocationS3Request {
|
|
|
853
847
|
* <p>The Amazon S3 storage class that you want to store your files in when this location is
|
|
854
848
|
* used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard.
|
|
855
849
|
* For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.</p>
|
|
856
|
-
*
|
|
857
850
|
* <p>For more information about S3 storage classes, see <a href="http://aws.amazon.com/s3/storage-classes/">Amazon S3 Storage Classes</a>. Some storage classes have behaviors that
|
|
858
851
|
* can affect your S3 storage cost. For detailed information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations when working with S3 storage classes in DataSync</a>.</p>
|
|
859
852
|
*/
|
|
@@ -861,7 +854,6 @@ export interface CreateLocationS3Request {
|
|
|
861
854
|
/**
|
|
862
855
|
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access
|
|
863
856
|
* an Amazon S3 bucket.</p>
|
|
864
|
-
*
|
|
865
857
|
* <p>For detailed information about using such a role, see Creating a Location for
|
|
866
858
|
* Amazon S3 in the <i>DataSync User Guide</i>.</p>
|
|
867
859
|
*/
|
|
@@ -903,7 +895,6 @@ export interface CreateLocationSmbRequest {
|
|
|
903
895
|
* <code>Subdirectory</code> must be specified with forward slashes. For example,
|
|
904
896
|
* <code>/path/to/folder</code>.</p>
|
|
905
897
|
* </note>
|
|
906
|
-
*
|
|
907
898
|
* <p>To transfer all the data in the folder you specified, DataSync needs to have permissions
|
|
908
899
|
* to mount the SMB share, as well as to access all the data in that share. To ensure this,
|
|
909
900
|
* either ensure that the user/password specified belongs to the user who can mount the share,
|
|
@@ -925,7 +916,6 @@ export interface CreateLocationSmbRequest {
|
|
|
925
916
|
/**
|
|
926
917
|
* <p>The user who can mount the share, has the permissions to access files and folders in the
|
|
927
918
|
* SMB share.</p>
|
|
928
|
-
*
|
|
929
919
|
* <p>For information about choosing a user name that ensures sufficient permissions to files,
|
|
930
920
|
* folders, and metadata, see the <a href="create-smb-location.html#SMBuser">User setting</a> for SMB locations.</p>
|
|
931
921
|
*/
|
|
@@ -1046,57 +1036,59 @@ export declare enum VerifyMode {
|
|
|
1046
1036
|
POINT_IN_TIME_CONSISTENT = "POINT_IN_TIME_CONSISTENT"
|
|
1047
1037
|
}
|
|
1048
1038
|
/**
|
|
1049
|
-
* <p>
|
|
1050
|
-
*
|
|
1051
|
-
*
|
|
1052
|
-
*
|
|
1053
|
-
*
|
|
1054
|
-
* <p>A task has a set of default options associated with it. If you don't specify an option
|
|
1055
|
-
* in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
|
|
1056
|
-
* the default value is used. You can override the
|
|
1057
|
-
* defaults options on each task execution by specifying an overriding <code>Options</code> value
|
|
1058
|
-
* to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
|
|
1039
|
+
* <p>Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how
|
|
1040
|
+
* DataSync verifies data integrity, set bandwidth limits for your task, among other
|
|
1041
|
+
* options.</p>
|
|
1042
|
+
* <p>Each task setting has a default value. Unless you need to, you don't have to configure
|
|
1043
|
+
* any of these <code>Options</code> before starting your task.</p>
|
|
1059
1044
|
*/
|
|
1060
1045
|
export interface Options {
|
|
1061
1046
|
/**
|
|
1062
|
-
* <p>
|
|
1063
|
-
*
|
|
1064
|
-
* For more information, see
|
|
1065
|
-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html">Configure task settings</a>.
|
|
1066
|
-
* </p>
|
|
1047
|
+
* <p>Specifies how and when DataSync checks the integrity of your data during a
|
|
1048
|
+
* transfer. </p>
|
|
1067
1049
|
* <p>Default value: <code>POINT_IN_TIME_CONSISTENT</code>
|
|
1068
1050
|
* </p>
|
|
1069
1051
|
* <p>
|
|
1070
|
-
* <code>ONLY_FILES_TRANSFERRED</code> (recommended):
|
|
1071
|
-
*
|
|
1072
|
-
*
|
|
1052
|
+
* <code>ONLY_FILES_TRANSFERRED</code> (recommended): DataSync calculates the checksum of
|
|
1053
|
+
* transferred files and metadata at the source location. At the end of the transfer, DataSync then
|
|
1054
|
+
* compares this checksum to the checksum calculated on those files at the destination.</p>
|
|
1055
|
+
* <p>We recommend this option when transferring to S3 Glacier Flexible Retrieval or
|
|
1056
|
+
* S3 Glacier Deep Archive storage classes. For more information, see
|
|
1057
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Storage class
|
|
1058
|
+
* considerations with Amazon S3 locations</a>.</p>
|
|
1073
1059
|
* <p>
|
|
1074
|
-
* <code>POINT_IN_TIME_CONSISTENT</code>:
|
|
1075
|
-
* the
|
|
1076
|
-
*
|
|
1060
|
+
* <code>POINT_IN_TIME_CONSISTENT</code>: At the end of the transfer, DataSync
|
|
1061
|
+
* scans the entire source and destination to verify that both locations are fully
|
|
1062
|
+
* synchronized.</p>
|
|
1063
|
+
* <p>You can't use this option when transferring to S3 Glacier Flexible Retrieval or
|
|
1064
|
+
* S3 Glacier Deep Archive storage classes. For more information, see
|
|
1065
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Storage class
|
|
1066
|
+
* considerations with Amazon S3 locations</a>.</p>
|
|
1077
1067
|
* <p>
|
|
1078
|
-
* <code>NONE</code>:
|
|
1079
|
-
*
|
|
1080
|
-
* transfer.</p>
|
|
1068
|
+
* <code>NONE</code>: DataSync doesn't run additional verification at the end of
|
|
1069
|
+
* the transfer. All data transmissions are still integrity-checked with checksum verification
|
|
1070
|
+
* during the transfer.</p>
|
|
1081
1071
|
*/
|
|
1082
1072
|
VerifyMode?: VerifyMode | string;
|
|
1083
1073
|
/**
|
|
1084
|
-
* <p>
|
|
1085
|
-
*
|
|
1086
|
-
*
|
|
1087
|
-
* protect against overwriting
|
|
1088
|
-
*
|
|
1089
|
-
*
|
|
1090
|
-
*
|
|
1091
|
-
*
|
|
1074
|
+
* <p>Specifies whether data at the destination location should be overwritten or preserved. If
|
|
1075
|
+
* set to <code>NEVER</code>, a destination file for example will not be replaced by a source
|
|
1076
|
+
* file (even if the destination file differs from the source file). If you modify files in the
|
|
1077
|
+
* destination and you sync the files, you can use this value to protect against overwriting
|
|
1078
|
+
* those changes. </p>
|
|
1079
|
+
* <p>Some storage classes have specific behaviors that can affect your Amazon S3
|
|
1080
|
+
* storage cost. For detailed information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations
|
|
1081
|
+
* when working with Amazon S3 storage classes in DataSync </a>.</p>
|
|
1092
1082
|
*/
|
|
1093
1083
|
OverwriteMode?: OverwriteMode | string;
|
|
1094
1084
|
/**
|
|
1095
|
-
* <p>
|
|
1096
|
-
*
|
|
1097
|
-
*
|
|
1098
|
-
*
|
|
1099
|
-
*
|
|
1085
|
+
* <p>Specifies whether to preserve metadata indicating the last time a file was read or
|
|
1086
|
+
* written to. If you set <code>Atime</code> to <code>BEST_EFFORT</code>, DataSync
|
|
1087
|
+
* attempts to preserve the original <code>Atime</code> attribute on all source files (that is,
|
|
1088
|
+
* the version before the <code>PREPARING</code> phase of the task execution).</p>
|
|
1089
|
+
* <note>
|
|
1090
|
+
* <p>The behavior of <code>Atime</code> isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.</p>
|
|
1091
|
+
* </note>
|
|
1100
1092
|
* <p>Default value: <code>BEST_EFFORT</code>
|
|
1101
1093
|
* </p>
|
|
1102
1094
|
* <p>
|
|
@@ -1113,9 +1105,9 @@ export interface Options {
|
|
|
1113
1105
|
*/
|
|
1114
1106
|
Atime?: Atime | string;
|
|
1115
1107
|
/**
|
|
1116
|
-
* <p>
|
|
1117
|
-
*
|
|
1118
|
-
* you need to run the
|
|
1108
|
+
* <p>Specifies whether to preserve metadata indicating the last time that a file was written
|
|
1109
|
+
* to before the <code>PREPARING</code> phase of your task execution. This option is required
|
|
1110
|
+
* when you need to run the a task more than once.</p>
|
|
1119
1111
|
* <p>Default Value: <code>PRESERVE</code>
|
|
1120
1112
|
* </p>
|
|
1121
1113
|
* <p>
|
|
@@ -1131,7 +1123,7 @@ export interface Options {
|
|
|
1131
1123
|
*/
|
|
1132
1124
|
Mtime?: Mtime | string;
|
|
1133
1125
|
/**
|
|
1134
|
-
* <p>
|
|
1126
|
+
* <p>Specifies the POSIX user ID (UID) of the file's owner.</p>
|
|
1135
1127
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata copied by DataSync</a>.</p>
|
|
1136
1128
|
* <p>Default value: <code>INT_VALUE</code>. This preserves the integer value of the ID.</p>
|
|
1137
1129
|
* <p>
|
|
@@ -1142,7 +1134,7 @@ export interface Options {
|
|
|
1142
1134
|
*/
|
|
1143
1135
|
Uid?: Uid | string;
|
|
1144
1136
|
/**
|
|
1145
|
-
* <p>
|
|
1137
|
+
* <p>Specifies the POSIX group ID (GID) of the file's owners.</p>
|
|
1146
1138
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata copied by DataSync</a>.</p>
|
|
1147
1139
|
* <p>Default value: <code>INT_VALUE</code>. This preserves the integer value of the ID.</p>
|
|
1148
1140
|
* <p>
|
|
@@ -1153,11 +1145,11 @@ export interface Options {
|
|
|
1153
1145
|
*/
|
|
1154
1146
|
Gid?: Gid | string;
|
|
1155
1147
|
/**
|
|
1156
|
-
* <p>
|
|
1157
|
-
*
|
|
1158
|
-
*
|
|
1159
|
-
* information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations
|
|
1160
|
-
*
|
|
1148
|
+
* <p>Specifies whether files in the destination location that don't exist in the source
|
|
1149
|
+
* should be preserved. This option can affect your Amazon S3 storage cost. If your task
|
|
1150
|
+
* deletes objects, you might incur minimum storage duration charges for certain storage classes.
|
|
1151
|
+
* For detailed information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations
|
|
1152
|
+
* when working with Amazon S3 storage classes in DataSync </a>.</p>
|
|
1161
1153
|
* <p>Default value: <code>PRESERVE</code>
|
|
1162
1154
|
* </p>
|
|
1163
1155
|
* <p>
|
|
@@ -1168,12 +1160,12 @@ export interface Options {
|
|
|
1168
1160
|
*/
|
|
1169
1161
|
PreserveDeletedFiles?: PreserveDeletedFiles | string;
|
|
1170
1162
|
/**
|
|
1171
|
-
* <p>
|
|
1172
|
-
*
|
|
1173
|
-
*
|
|
1174
|
-
*
|
|
1163
|
+
* <p>Specifies whether DataSync should preserve the metadata of block and
|
|
1164
|
+
* character devices in the source location and recreate the files with that device name and
|
|
1165
|
+
* metadata on the destination. DataSync copies only the name and metadata of such
|
|
1166
|
+
* devices.</p>
|
|
1175
1167
|
* <note>
|
|
1176
|
-
* <p>DataSync can't
|
|
1168
|
+
* <p>DataSync can't copy the actual contents of these devices because they're
|
|
1177
1169
|
* nonterminal and don't return an end-of-file (EOF) marker.</p>
|
|
1178
1170
|
* </note>
|
|
1179
1171
|
* <p>Default value: <code>NONE</code>
|
|
@@ -1181,13 +1173,13 @@ export interface Options {
|
|
|
1181
1173
|
* <p>
|
|
1182
1174
|
* <code>NONE</code>: Ignore special devices (recommended). </p>
|
|
1183
1175
|
* <p>
|
|
1184
|
-
* <code>PRESERVE</code>: Preserve character and block device metadata. This option
|
|
1185
|
-
* currently supported for Amazon EFS. </p>
|
|
1176
|
+
* <code>PRESERVE</code>: Preserve character and block device metadata. This option
|
|
1177
|
+
* currently isn't supported for Amazon EFS. </p>
|
|
1186
1178
|
*/
|
|
1187
1179
|
PreserveDevices?: PreserveDevices | string;
|
|
1188
1180
|
/**
|
|
1189
|
-
* <p>
|
|
1190
|
-
*
|
|
1181
|
+
* <p>Specifies which users or groups can access a file for a specific purpose such as reading,
|
|
1182
|
+
* writing, or execution of the file.</p>
|
|
1191
1183
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata copied by DataSync</a>.</p>
|
|
1192
1184
|
* <p>Default value: <code>PRESERVE</code>
|
|
1193
1185
|
* </p>
|
|
@@ -1201,88 +1193,79 @@ export interface Options {
|
|
|
1201
1193
|
*/
|
|
1202
1194
|
PosixPermissions?: PosixPermissions | string;
|
|
1203
1195
|
/**
|
|
1204
|
-
* <p>
|
|
1205
|
-
*
|
|
1196
|
+
* <p>Limits the bandwidth used by a DataSync task. For example, if you want
|
|
1197
|
+
* DataSync to use a maximum of 1 MB, set this value to <code>1048576</code>
|
|
1206
1198
|
* (<code>=1024*1024</code>).</p>
|
|
1207
1199
|
*/
|
|
1208
1200
|
BytesPerSecond?: number;
|
|
1209
1201
|
/**
|
|
1210
|
-
* <p>
|
|
1211
|
-
*
|
|
1202
|
+
* <p>Specifies whether tasks should be queued before executing the tasks. The default is
|
|
1203
|
+
* <code>ENABLED</code>, which means the tasks will be queued.</p>
|
|
1212
1204
|
* <p>If you use the same agent to run multiple tasks, you can enable the tasks to run in
|
|
1213
1205
|
* series. For more information, see
|
|
1214
1206
|
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution">Queueing task executions</a>.</p>
|
|
1215
1207
|
*/
|
|
1216
1208
|
TaskQueueing?: TaskQueueing | string;
|
|
1217
1209
|
/**
|
|
1218
|
-
* <p>
|
|
1219
|
-
*
|
|
1220
|
-
*
|
|
1221
|
-
* <code>BASIC</code> publishes logs on errors for individual files transferred
|
|
1210
|
+
* <p>Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log
|
|
1211
|
+
* group. To specify the log group, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn">CloudWatchLogGroupArn</a>.</p>
|
|
1212
|
+
* <p>If you set <code>LogLevel</code> to <code>OFF</code>, no logs are published.
|
|
1213
|
+
* <code>BASIC</code> publishes logs on errors for individual files transferred.
|
|
1222
1214
|
* <code>TRANSFER</code> publishes logs for every file or object that is transferred and
|
|
1223
1215
|
* integrity checked.</p>
|
|
1224
1216
|
*/
|
|
1225
1217
|
LogLevel?: LogLevel | string;
|
|
1226
1218
|
/**
|
|
1227
|
-
* <p>
|
|
1228
|
-
* and the destination location
|
|
1229
|
-
* the destination
|
|
1219
|
+
* <p>Determines whether DataSync transfers only the data and metadata that differ
|
|
1220
|
+
* between the source and the destination location or transfers all the content from the source
|
|
1221
|
+
* (without comparing what's in the destination).</p>
|
|
1230
1222
|
* <p>
|
|
1231
1223
|
* <code>CHANGED</code>: DataSync copies only data or metadata that is new or
|
|
1232
1224
|
* different content from the source location to the destination location.</p>
|
|
1233
1225
|
* <p>
|
|
1234
|
-
* <code>ALL</code>: DataSync copies all source location content to the
|
|
1235
|
-
*
|
|
1226
|
+
* <code>ALL</code>: DataSync copies all source location content to the destination
|
|
1227
|
+
* (without comparing what's in the destination).</p>
|
|
1236
1228
|
*/
|
|
1237
1229
|
TransferMode?: TransferMode | string;
|
|
1238
1230
|
/**
|
|
1239
|
-
* <p>
|
|
1240
|
-
*
|
|
1241
|
-
*
|
|
1242
|
-
*
|
|
1243
|
-
* between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File
|
|
1244
|
-
* Server locations. For more information about how
|
|
1245
|
-
* DataSync handles metadata, see
|
|
1246
|
-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html">How DataSync Handles Metadata and Special Files</a>.
|
|
1247
|
-
* </p>
|
|
1231
|
+
* <p>Specifies which components of the SMB security descriptor are copied from source to
|
|
1232
|
+
* destination objects. </p>
|
|
1233
|
+
* <p>This value is only used for transfers between SMB and Amazon FSx for Windows File Server
|
|
1234
|
+
* locations or between two FSx for Windows File Server locations. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html">how DataSync handles metadata</a>.</p>
|
|
1248
1235
|
* <p>Default value: <code>OWNER_DACL</code>
|
|
1249
1236
|
* </p>
|
|
1250
|
-
*
|
|
1251
1237
|
* <p>
|
|
1252
1238
|
* <code>OWNER_DACL</code>: For each copied object, DataSync copies the following
|
|
1253
1239
|
* metadata:</p>
|
|
1254
1240
|
* <ul>
|
|
1255
1241
|
* <li>
|
|
1256
|
-
* <p>
|
|
1242
|
+
* <p>The object owner.</p>
|
|
1257
1243
|
* </li>
|
|
1258
1244
|
* <li>
|
|
1259
1245
|
* <p>NTFS discretionary access control lists (DACLs), which determine whether to
|
|
1260
1246
|
* grant access to an object.</p>
|
|
1247
|
+
* <p>DataSync won't copy NTFS system access control lists (SACLs) with this
|
|
1248
|
+
* option.</p>
|
|
1261
1249
|
* </li>
|
|
1262
1250
|
* </ul>
|
|
1263
|
-
* <p>When choosing this option, DataSync does NOT copy the NTFS system access control lists
|
|
1264
|
-
* (SACLs), which are used by administrators to log attempts to access a secured object.</p>
|
|
1265
|
-
*
|
|
1266
1251
|
* <p>
|
|
1267
|
-
* <code>OWNER_DACL_SACL</code>: For each copied object, DataSync copies the
|
|
1268
|
-
* metadata:</p>
|
|
1252
|
+
* <code>OWNER_DACL_SACL</code>: For each copied object, DataSync copies the
|
|
1253
|
+
* following metadata:</p>
|
|
1269
1254
|
* <ul>
|
|
1270
1255
|
* <li>
|
|
1271
|
-
* <p>
|
|
1256
|
+
* <p>The object owner.</p>
|
|
1272
1257
|
* </li>
|
|
1273
1258
|
* <li>
|
|
1274
1259
|
* <p>NTFS discretionary access control lists (DACLs), which determine whether to
|
|
1275
1260
|
* grant access to an object.</p>
|
|
1276
1261
|
* </li>
|
|
1277
1262
|
* <li>
|
|
1278
|
-
* <p>
|
|
1279
|
-
*
|
|
1263
|
+
* <p>SACLs, which are used by administrators to log attempts to access a secured object.</p>
|
|
1264
|
+
* <p>Copying SACLs requires granting additional permissions to the Windows user that
|
|
1265
|
+
* DataSync uses to access your SMB location. For information about choosing a user that
|
|
1266
|
+
* ensures sufficient permissions to files, folders, and metadata, see <a href="create-smb-location.html#SMBuser">user</a>.</p>
|
|
1280
1267
|
* </li>
|
|
1281
1268
|
* </ul>
|
|
1282
|
-
* <p>Copying SACLs requires granting additional permissions to the Windows user that DataSync
|
|
1283
|
-
* uses to access your SMB location. For information about choosing a user that ensures
|
|
1284
|
-
* sufficient permissions to files, folders, and metadata, see <a href="create-smb-location.html#SMBuser">user</a>.</p>
|
|
1285
|
-
*
|
|
1286
1269
|
* <p>
|
|
1287
1270
|
* <code>NONE</code>: None of the SMB security descriptor components are copied. Destination
|
|
1288
1271
|
* objects are owned by the user that was provided for accessing the destination location. DACLs
|
|
@@ -1290,7 +1273,9 @@ export interface Options {
|
|
|
1290
1273
|
*/
|
|
1291
1274
|
SecurityDescriptorCopyFlags?: SmbSecurityDescriptorCopyFlags | string;
|
|
1292
1275
|
/**
|
|
1293
|
-
* <p>Specifies whether object tags are
|
|
1276
|
+
* <p>Specifies whether object tags are preserved when transferring between object storage
|
|
1277
|
+
* systems. If you want your DataSync task to ignore object tags, specify the
|
|
1278
|
+
* <code>NONE</code> value.</p>
|
|
1294
1279
|
* <p>Default Value: <code>PRESERVE</code>
|
|
1295
1280
|
* </p>
|
|
1296
1281
|
*/
|
|
@@ -1330,21 +1315,14 @@ export interface CreateTaskRequest {
|
|
|
1330
1315
|
*/
|
|
1331
1316
|
Name?: string;
|
|
1332
1317
|
/**
|
|
1333
|
-
* <p>
|
|
1334
|
-
*
|
|
1335
|
-
*
|
|
1336
|
-
* integrity verification, and so on.</p>
|
|
1337
|
-
* <p>For each individual task execution, you can override these options by specifying the
|
|
1338
|
-
* <code>OverrideOptions</code> before starting the task execution. For more information, see
|
|
1339
|
-
* the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a> operation. </p>
|
|
1318
|
+
* <p>Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.</p>
|
|
1319
|
+
* <p>You can also override these options before starting an individual run of a task (also
|
|
1320
|
+
* known as a <i>task execution</i>). For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
|
|
1340
1321
|
*/
|
|
1341
1322
|
Options?: Options;
|
|
1342
1323
|
/**
|
|
1343
|
-
* <p>
|
|
1344
|
-
*
|
|
1345
|
-
* delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>. </p>
|
|
1346
|
-
* <p>
|
|
1347
|
-
* </p>
|
|
1324
|
+
* <p>Specifies a list of filter rules that exclude specific data during your transfer. For more
|
|
1325
|
+
* information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
1348
1326
|
*/
|
|
1349
1327
|
Excludes?: FilterRule[];
|
|
1350
1328
|
/**
|
|
@@ -1353,14 +1331,15 @@ export interface CreateTaskRequest {
|
|
|
1353
1331
|
*/
|
|
1354
1332
|
Schedule?: TaskSchedule;
|
|
1355
1333
|
/**
|
|
1356
|
-
* <p>
|
|
1357
|
-
*
|
|
1334
|
+
* <p>Specifies the tags that you want to apply to the Amazon Resource Name (ARN)
|
|
1335
|
+
* representing the task.</p>
|
|
1336
|
+
* <p>
|
|
1337
|
+
* <i>Tags</i> are key-value pairs that help you manage, filter, and search
|
|
1338
|
+
* for your DataSync resources.</p>
|
|
1358
1339
|
*/
|
|
1359
1340
|
Tags?: TagListEntry[];
|
|
1360
1341
|
/**
|
|
1361
|
-
* <p>
|
|
1362
|
-
* pattern contains a single filter string that consists of the patterns to include. The patterns
|
|
1363
|
-
* are delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>.</p>
|
|
1342
|
+
* <p>Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
1364
1343
|
*/
|
|
1365
1344
|
Includes?: FilterRule[];
|
|
1366
1345
|
}
|
|
@@ -1401,7 +1380,7 @@ export interface DeleteLocationResponse {
|
|
|
1401
1380
|
*/
|
|
1402
1381
|
export interface DeleteTaskRequest {
|
|
1403
1382
|
/**
|
|
1404
|
-
* <p>
|
|
1383
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the task that you want to delete.</p>
|
|
1405
1384
|
*/
|
|
1406
1385
|
TaskArn: string | undefined;
|
|
1407
1386
|
}
|
|
@@ -1835,7 +1814,6 @@ export interface DescribeLocationS3Response {
|
|
|
1835
1814
|
/**
|
|
1836
1815
|
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access
|
|
1837
1816
|
* an Amazon S3 bucket.</p>
|
|
1838
|
-
*
|
|
1839
1817
|
* <p>For detailed information about using such a role, see Creating a Location for
|
|
1840
1818
|
* Amazon S3 in the <i>DataSync User Guide</i>.</p>
|
|
1841
1819
|
*/
|
|
@@ -1921,8 +1899,6 @@ export interface DescribeTaskResponse {
|
|
|
1921
1899
|
TaskArn?: string;
|
|
1922
1900
|
/**
|
|
1923
1901
|
* <p>The status of the task that was described.</p>
|
|
1924
|
-
*
|
|
1925
|
-
*
|
|
1926
1902
|
* <p>For detailed information about task execution statuses, see Understanding
|
|
1927
1903
|
* Task Statuses in the <i>DataSync User Guide</i>.</p>
|
|
1928
1904
|
*/
|
|
@@ -1932,7 +1908,7 @@ export interface DescribeTaskResponse {
|
|
|
1932
1908
|
*/
|
|
1933
1909
|
Name?: string;
|
|
1934
1910
|
/**
|
|
1935
|
-
* <p>The Amazon Resource Name (ARN) of the task execution that is
|
|
1911
|
+
* <p>The Amazon Resource Name (ARN) of the task execution that is transferring files.</p>
|
|
1936
1912
|
*/
|
|
1937
1913
|
CurrentTaskExecutionArn?: string;
|
|
1938
1914
|
/**
|
|
@@ -1946,37 +1922,25 @@ export interface DescribeTaskResponse {
|
|
|
1946
1922
|
/**
|
|
1947
1923
|
* <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to
|
|
1948
1924
|
* monitor and log events in the task.</p>
|
|
1949
|
-
*
|
|
1950
|
-
*
|
|
1951
1925
|
* <p>For more information on these groups, see Working with Log Groups and Log
|
|
1952
1926
|
* Streams in the <i>Amazon CloudWatch User Guide</i>.</p>
|
|
1953
1927
|
*/
|
|
1954
1928
|
CloudWatchLogGroupArn?: string;
|
|
1955
1929
|
/**
|
|
1956
|
-
* <p>The Amazon Resource Names (ARNs) of the source
|
|
1957
|
-
* created for your subnet.</p>
|
|
1930
|
+
* <p>The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">Network interface requirements</a>.</p>
|
|
1958
1931
|
*/
|
|
1959
1932
|
SourceNetworkInterfaceArns?: string[];
|
|
1960
1933
|
/**
|
|
1961
|
-
* <p>The Amazon Resource Names (ARNs) of the destination
|
|
1962
|
-
* were created for your subnet.</p>
|
|
1934
|
+
* <p>The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">Network interface requirements</a>.</p>
|
|
1963
1935
|
*/
|
|
1964
1936
|
DestinationNetworkInterfaceArns?: string[];
|
|
1965
1937
|
/**
|
|
1966
|
-
* <p>The
|
|
1967
|
-
*
|
|
1968
|
-
* options to preserve metadata such as user ID (UID) and group (GID), file permissions, data
|
|
1969
|
-
* integrity verification, and so on.</p>
|
|
1970
|
-
* <p>For each individual task execution, you can override these options by specifying the
|
|
1971
|
-
* overriding <code>OverrideOptions</code> value to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a> operation. </p>
|
|
1938
|
+
* <p>The configuration options that control the behavior of the <code>StartTaskExecution</code> operation. Some options include preserving file or object metadata and verifying data integrity.</p>
|
|
1939
|
+
* <p>You can override these options for each task execution. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
|
|
1972
1940
|
*/
|
|
1973
1941
|
Options?: Options;
|
|
1974
1942
|
/**
|
|
1975
|
-
* <p>A list of filter rules that
|
|
1976
|
-
* contain a single filter string that consists of the patterns to exclude. The patterns are
|
|
1977
|
-
* delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>. </p>
|
|
1978
|
-
* <p>
|
|
1979
|
-
* </p>
|
|
1943
|
+
* <p>A list of filter rules that exclude specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
1980
1944
|
*/
|
|
1981
1945
|
Excludes?: FilterRule[];
|
|
1982
1946
|
/**
|
|
@@ -1998,9 +1962,7 @@ export interface DescribeTaskResponse {
|
|
|
1998
1962
|
*/
|
|
1999
1963
|
CreationTime?: Date;
|
|
2000
1964
|
/**
|
|
2001
|
-
* <p>A list of filter rules that
|
|
2002
|
-
* pattern contains a single filter string that consists of the patterns to include. The patterns
|
|
2003
|
-
* are delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2</code>".</p>
|
|
1965
|
+
* <p>A list of filter rules that include specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
2004
1966
|
*/
|
|
2005
1967
|
Includes?: FilterRule[];
|
|
2006
1968
|
}
|
|
@@ -2091,38 +2053,25 @@ export interface DescribeTaskExecutionResponse {
|
|
|
2091
2053
|
TaskExecutionArn?: string;
|
|
2092
2054
|
/**
|
|
2093
2055
|
* <p>The status of the task execution. </p>
|
|
2094
|
-
*
|
|
2095
|
-
*
|
|
2096
2056
|
* <p>For detailed information about task execution statuses, see Understanding
|
|
2097
2057
|
* Task Statuses in the <i>DataSync User Guide.</i>
|
|
2098
2058
|
* </p>
|
|
2099
2059
|
*/
|
|
2100
2060
|
Status?: TaskExecutionStatus | string;
|
|
2101
2061
|
/**
|
|
2102
|
-
* <p>
|
|
2103
|
-
*
|
|
2104
|
-
*
|
|
2105
|
-
*
|
|
2106
|
-
*
|
|
2107
|
-
* <p>A task has a set of default options associated with it. If you don't specify an option
|
|
2108
|
-
* in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
|
|
2109
|
-
* the default value is used. You can override the
|
|
2110
|
-
* defaults options on each task execution by specifying an overriding <code>Options</code> value
|
|
2111
|
-
* to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
|
|
2062
|
+
* <p>Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how
|
|
2063
|
+
* DataSync verifies data integrity, set bandwidth limits for your task, among other
|
|
2064
|
+
* options.</p>
|
|
2065
|
+
* <p>Each task setting has a default value. Unless you need to, you don't have to configure
|
|
2066
|
+
* any of these <code>Options</code> before starting your task.</p>
|
|
2112
2067
|
*/
|
|
2113
2068
|
Options?: Options;
|
|
2114
2069
|
/**
|
|
2115
|
-
* <p>A list of filter rules that
|
|
2116
|
-
* contain a single filter string that consists of the patterns to exclude. The patterns are
|
|
2117
|
-
* delimited by "|" (that is, a pipe), for example: <code>"/folder1|/folder2"</code>
|
|
2118
|
-
* </p>
|
|
2070
|
+
* <p>A list of filter rules that exclude specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
2119
2071
|
*/
|
|
2120
2072
|
Excludes?: FilterRule[];
|
|
2121
2073
|
/**
|
|
2122
|
-
* <p>A list of filter rules that
|
|
2123
|
-
* list should contain a single filter string that consists of the patterns to include. The
|
|
2124
|
-
* patterns are delimited by "|" (that is, a pipe), for example: <code>"/folder1|/folder2"</code>
|
|
2125
|
-
* </p>
|
|
2074
|
+
* <p>A list of filter rules that include specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
2126
2075
|
*/
|
|
2127
2076
|
Includes?: FilterRule[];
|
|
2128
2077
|
/**
|
|
@@ -2131,10 +2080,10 @@ export interface DescribeTaskExecutionResponse {
|
|
|
2131
2080
|
StartTime?: Date;
|
|
2132
2081
|
/**
|
|
2133
2082
|
* <p>The expected number of files that is to be transferred over the network. This value is
|
|
2134
|
-
* calculated during the PREPARING phase
|
|
2135
|
-
* expected number of files to be transferred. It's
|
|
2136
|
-
* content of the source and destination locations and finding
|
|
2137
|
-
* transferred. </p>
|
|
2083
|
+
* calculated during the <code>PREPARING</code> phase before the <code>TRANSFERRING</code> phase
|
|
2084
|
+
* of the task execution. This value is the expected number of files to be transferred. It's
|
|
2085
|
+
* calculated based on comparing the content of the source and destination locations and finding
|
|
2086
|
+
* the delta that needs to be transferred. </p>
|
|
2138
2087
|
*/
|
|
2139
2088
|
EstimatedFilesToTransfer?: number;
|
|
2140
2089
|
/**
|
|
@@ -2144,13 +2093,14 @@ export interface DescribeTaskExecutionResponse {
|
|
|
2144
2093
|
EstimatedBytesToTransfer?: number;
|
|
2145
2094
|
/**
|
|
2146
2095
|
* <p>The actual number of files that was transferred over the network. This value is
|
|
2147
|
-
* calculated and updated on an ongoing basis during the TRANSFERRING phase
|
|
2148
|
-
* periodically when each file is read from the source and sent over
|
|
2096
|
+
* calculated and updated on an ongoing basis during the <code>TRANSFERRING</code> phase of the
|
|
2097
|
+
* task execution. It's updated periodically when each file is read from the source and sent over
|
|
2098
|
+
* the network. </p>
|
|
2149
2099
|
* <p>If failures occur during a transfer, this value can be less than
|
|
2150
|
-
* <code>EstimatedFilesToTransfer</code>.
|
|
2151
|
-
* <code>
|
|
2152
|
-
*
|
|
2153
|
-
*
|
|
2100
|
+
* <code>EstimatedFilesToTransfer</code>. In some cases, this value can also be greater than
|
|
2101
|
+
* <code>EstimatedFilesToTransfer</code>. This element is implementation-specific for some
|
|
2102
|
+
* location types, so don't use it as an indicator for a correct file number or to monitor your
|
|
2103
|
+
* task execution.</p>
|
|
2154
2104
|
*/
|
|
2155
2105
|
FilesTransferred?: number;
|
|
2156
2106
|
/**
|
|
@@ -2158,7 +2108,8 @@ export interface DescribeTaskExecutionResponse {
|
|
|
2158
2108
|
*/
|
|
2159
2109
|
BytesWritten?: number;
|
|
2160
2110
|
/**
|
|
2161
|
-
* <p>The
|
|
2111
|
+
* <p>The total number of bytes that are involved in the transfer. For the number of bytes
|
|
2112
|
+
* sent over the network, see <code>BytesCompressed</code>. </p>
|
|
2162
2113
|
*/
|
|
2163
2114
|
BytesTransferred?: number;
|
|
2164
2115
|
/**
|
|
@@ -2167,7 +2118,8 @@ export interface DescribeTaskExecutionResponse {
|
|
|
2167
2118
|
Result?: TaskExecutionResultDetail;
|
|
2168
2119
|
/**
|
|
2169
2120
|
* <p>The physical number of bytes transferred over the network after compression was applied.
|
|
2170
|
-
* In most cases, this number is less than <code>BytesTransferred</code
|
|
2121
|
+
* In most cases, this number is less than <code>BytesTransferred</code> unless the data isn't
|
|
2122
|
+
* compressible.</p>
|
|
2171
2123
|
*/
|
|
2172
2124
|
BytesCompressed?: number;
|
|
2173
2125
|
}
|
|
@@ -2312,16 +2264,15 @@ export interface ListLocationsResponse {
|
|
|
2312
2264
|
*/
|
|
2313
2265
|
export interface ListTagsForResourceRequest {
|
|
2314
2266
|
/**
|
|
2315
|
-
* <p>
|
|
2267
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the resource that you want tag information on.</p>
|
|
2316
2268
|
*/
|
|
2317
2269
|
ResourceArn: string | undefined;
|
|
2318
2270
|
/**
|
|
2319
|
-
* <p>
|
|
2271
|
+
* <p>Specifies how many results that you want in the response.</p>
|
|
2320
2272
|
*/
|
|
2321
2273
|
MaxResults?: number;
|
|
2322
2274
|
/**
|
|
2323
|
-
* <p>
|
|
2324
|
-
* locations.</p>
|
|
2275
|
+
* <p>Specifies an opaque string that indicates the position to begin the next list of results in the response.</p>
|
|
2325
2276
|
*/
|
|
2326
2277
|
NextToken?: string;
|
|
2327
2278
|
}
|
|
@@ -2330,12 +2281,11 @@ export interface ListTagsForResourceRequest {
|
|
|
2330
2281
|
*/
|
|
2331
2282
|
export interface ListTagsForResourceResponse {
|
|
2332
2283
|
/**
|
|
2333
|
-
* <p>
|
|
2284
|
+
* <p>An array of tags applied to the specified resource.</p>
|
|
2334
2285
|
*/
|
|
2335
2286
|
Tags?: TagListEntry[];
|
|
2336
2287
|
/**
|
|
2337
|
-
* <p>
|
|
2338
|
-
* of resource tags.</p>
|
|
2288
|
+
* <p>The opaque string that indicates the position to begin the next list of results in the response.</p>
|
|
2339
2289
|
*/
|
|
2340
2290
|
NextToken?: string;
|
|
2341
2291
|
}
|
|
@@ -2476,46 +2426,43 @@ export interface ListTasksResponse {
|
|
|
2476
2426
|
*/
|
|
2477
2427
|
export interface StartTaskExecutionRequest {
|
|
2478
2428
|
/**
|
|
2479
|
-
* <p>
|
|
2429
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the task that you want to start.</p>
|
|
2480
2430
|
*/
|
|
2481
2431
|
TaskArn: string | undefined;
|
|
2482
2432
|
/**
|
|
2483
|
-
* <p>
|
|
2484
|
-
*
|
|
2485
|
-
*
|
|
2486
|
-
*
|
|
2487
|
-
*
|
|
2488
|
-
* <p>A task has a set of default options associated with it. If you don't specify an option
|
|
2489
|
-
* in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
|
|
2490
|
-
* the default value is used. You can override the
|
|
2491
|
-
* defaults options on each task execution by specifying an overriding <code>Options</code> value
|
|
2492
|
-
* to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
|
|
2433
|
+
* <p>Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how
|
|
2434
|
+
* DataSync verifies data integrity, set bandwidth limits for your task, among other
|
|
2435
|
+
* options.</p>
|
|
2436
|
+
* <p>Each task setting has a default value. Unless you need to, you don't have to configure
|
|
2437
|
+
* any of these <code>Options</code> before starting your task.</p>
|
|
2493
2438
|
*/
|
|
2494
2439
|
OverrideOptions?: Options;
|
|
2495
2440
|
/**
|
|
2496
|
-
* <p>
|
|
2497
|
-
* pattern should contain a single filter string that consists of the patterns to
|
|
2498
|
-
* patterns are delimited by "|" (that is, a pipe), for example,
|
|
2499
|
-
*
|
|
2500
|
-
*
|
|
2501
|
-
* <p>
|
|
2502
|
-
* </p>
|
|
2441
|
+
* <p>Specifies a list of filter rules that determines which files to include when running a
|
|
2442
|
+
* task. The pattern should contain a single filter string that consists of the patterns to
|
|
2443
|
+
* include. The patterns are delimited by "|" (that is, a pipe), for example,
|
|
2444
|
+
* <code>"/folder1|/folder2"</code>. </p>
|
|
2503
2445
|
*/
|
|
2504
2446
|
Includes?: FilterRule[];
|
|
2505
2447
|
/**
|
|
2506
|
-
* <p>
|
|
2507
|
-
* contains a single filter string that consists of the patterns to exclude. The patterns
|
|
2508
|
-
* delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>. </p>
|
|
2448
|
+
* <p>Specifies a list of filter rules that determines which files to exclude from a task. The
|
|
2449
|
+
* list contains a single filter string that consists of the patterns to exclude. The patterns
|
|
2450
|
+
* are delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>. </p>
|
|
2509
2451
|
*/
|
|
2510
2452
|
Excludes?: FilterRule[];
|
|
2453
|
+
/**
|
|
2454
|
+
* <p>Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.</p>
|
|
2455
|
+
* <p>
|
|
2456
|
+
* <i>Tags</i> are key-value pairs that help you manage, filter, and search for your DataSync resources.</p>
|
|
2457
|
+
*/
|
|
2458
|
+
Tags?: TagListEntry[];
|
|
2511
2459
|
}
|
|
2512
2460
|
/**
|
|
2513
2461
|
* <p>StartTaskExecutionResponse</p>
|
|
2514
2462
|
*/
|
|
2515
2463
|
export interface StartTaskExecutionResponse {
|
|
2516
2464
|
/**
|
|
2517
|
-
* <p>The
|
|
2518
|
-
* started.</p>
|
|
2465
|
+
* <p>The ARN of the running task execution.</p>
|
|
2519
2466
|
*/
|
|
2520
2467
|
TaskExecutionArn?: string;
|
|
2521
2468
|
}
|
|
@@ -2524,11 +2471,11 @@ export interface StartTaskExecutionResponse {
|
|
|
2524
2471
|
*/
|
|
2525
2472
|
export interface TagResourceRequest {
|
|
2526
2473
|
/**
|
|
2527
|
-
* <p>
|
|
2474
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the resource to apply the tag to.</p>
|
|
2528
2475
|
*/
|
|
2529
2476
|
ResourceArn: string | undefined;
|
|
2530
2477
|
/**
|
|
2531
|
-
* <p>
|
|
2478
|
+
* <p>Specifies the tags that you want to apply to the resource.</p>
|
|
2532
2479
|
*/
|
|
2533
2480
|
Tags: TagListEntry[] | undefined;
|
|
2534
2481
|
}
|
|
@@ -2539,11 +2486,11 @@ export interface TagResourceResponse {
|
|
|
2539
2486
|
*/
|
|
2540
2487
|
export interface UntagResourceRequest {
|
|
2541
2488
|
/**
|
|
2542
|
-
* <p>
|
|
2489
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the resource to remove the tags from.</p>
|
|
2543
2490
|
*/
|
|
2544
2491
|
ResourceArn: string | undefined;
|
|
2545
2492
|
/**
|
|
2546
|
-
* <p>
|
|
2493
|
+
* <p>Specifies the keys in the tags that you want to remove.</p>
|
|
2547
2494
|
*/
|
|
2548
2495
|
Keys: string[] | undefined;
|
|
2549
2496
|
}
|
|
@@ -2641,7 +2588,6 @@ export interface UpdateLocationNfsRequest {
|
|
|
2641
2588
|
* location or write data to the NFS destination. The NFS path should be a path that's
|
|
2642
2589
|
* exported by the NFS server, or a subdirectory of that path. The path should be such that it
|
|
2643
2590
|
* can be mounted by other NFS clients in your network.</p>
|
|
2644
|
-
*
|
|
2645
2591
|
* <p>To see all the paths exported by your NFS server, run "<code>showmount -e
|
|
2646
2592
|
* nfs-server-name</code>" from an NFS client that has access to your server. You can specify
|
|
2647
2593
|
* any directory that appears in the results, and any subdirectory of that directory. Ensure that
|
|
@@ -2653,7 +2599,6 @@ export interface UpdateLocationNfsRequest {
|
|
|
2653
2599
|
* agent to read the files. For the agent to access directories, you must additionally enable all
|
|
2654
2600
|
* execute access.</p>
|
|
2655
2601
|
* <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p>
|
|
2656
|
-
*
|
|
2657
2602
|
* <p>For information about NFS export configuration, see 18.7. The /etc/exports
|
|
2658
2603
|
* Configuration File in the Red Hat Enterprise Linux documentation.</p>
|
|
2659
2604
|
*/
|
|
@@ -2731,7 +2676,6 @@ export interface UpdateLocationSmbRequest {
|
|
|
2731
2676
|
* <code>Subdirectory</code> must be specified with forward slashes. For example,
|
|
2732
2677
|
* <code>/path/to/folder</code>.</p>
|
|
2733
2678
|
* </note>
|
|
2734
|
-
*
|
|
2735
2679
|
* <p>To transfer all the data in the folder that you specified, DataSync must have
|
|
2736
2680
|
* permissions to mount the SMB share and to access all the data in that share. To ensure this,
|
|
2737
2681
|
* do either of the following:</p>
|
|
@@ -2784,24 +2728,15 @@ export interface UpdateTaskRequest {
|
|
|
2784
2728
|
*/
|
|
2785
2729
|
TaskArn: string | undefined;
|
|
2786
2730
|
/**
|
|
2787
|
-
* <p>
|
|
2788
|
-
*
|
|
2789
|
-
*
|
|
2790
|
-
*
|
|
2791
|
-
*
|
|
2792
|
-
* <p>A task has a set of default options associated with it. If you don't specify an option
|
|
2793
|
-
* in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
|
|
2794
|
-
* the default value is used. You can override the
|
|
2795
|
-
* defaults options on each task execution by specifying an overriding <code>Options</code> value
|
|
2796
|
-
* to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
|
|
2731
|
+
* <p>Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how
|
|
2732
|
+
* DataSync verifies data integrity, set bandwidth limits for your task, among other
|
|
2733
|
+
* options.</p>
|
|
2734
|
+
* <p>Each task setting has a default value. Unless you need to, you don't have to configure
|
|
2735
|
+
* any of these <code>Options</code> before starting your task.</p>
|
|
2797
2736
|
*/
|
|
2798
2737
|
Options?: Options;
|
|
2799
2738
|
/**
|
|
2800
|
-
* <p>
|
|
2801
|
-
* contain a single filter string that consists of the patterns to exclude. The patterns are
|
|
2802
|
-
* delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>.</p>
|
|
2803
|
-
* <p>
|
|
2804
|
-
* </p>
|
|
2739
|
+
* <p>Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
2805
2740
|
*/
|
|
2806
2741
|
Excludes?: FilterRule[];
|
|
2807
2742
|
/**
|
|
@@ -2821,9 +2756,7 @@ export interface UpdateTaskRequest {
|
|
|
2821
2756
|
*/
|
|
2822
2757
|
CloudWatchLogGroupArn?: string;
|
|
2823
2758
|
/**
|
|
2824
|
-
* <p>
|
|
2825
|
-
* pattern contains a single filter string that consists of the patterns to include. The patterns
|
|
2826
|
-
* are delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>.</p>
|
|
2759
|
+
* <p>Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
2827
2760
|
*/
|
|
2828
2761
|
Includes?: FilterRule[];
|
|
2829
2762
|
}
|
|
@@ -2835,16 +2768,11 @@ export interface UpdateTaskExecutionRequest {
|
|
|
2835
2768
|
*/
|
|
2836
2769
|
TaskExecutionArn: string | undefined;
|
|
2837
2770
|
/**
|
|
2838
|
-
* <p>
|
|
2839
|
-
*
|
|
2840
|
-
*
|
|
2841
|
-
*
|
|
2842
|
-
*
|
|
2843
|
-
* <p>A task has a set of default options associated with it. If you don't specify an option
|
|
2844
|
-
* in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
|
|
2845
|
-
* the default value is used. You can override the
|
|
2846
|
-
* defaults options on each task execution by specifying an overriding <code>Options</code> value
|
|
2847
|
-
* to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
|
|
2771
|
+
* <p>Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how
|
|
2772
|
+
* DataSync verifies data integrity, set bandwidth limits for your task, among other
|
|
2773
|
+
* options.</p>
|
|
2774
|
+
* <p>Each task setting has a default value. Unless you need to, you don't have to configure
|
|
2775
|
+
* any of these <code>Options</code> before starting your task.</p>
|
|
2848
2776
|
*/
|
|
2849
2777
|
Options: Options | undefined;
|
|
2850
2778
|
}
|