aws-sdk 2.975.0 → 2.976.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/CHANGELOG.md +8 -1
- package/README.md +1 -1
- package/apis/datasync-2018-11-09.min.json +13 -1
- package/apis/ec2-2016-11-15.min.json +216 -211
- package/apis/fms-2018-01-01.min.json +6 -0
- package/clients/cloudwatchevents.d.ts +67 -67
- package/clients/datasync.d.ts +69 -53
- package/clients/ec2.d.ts +44 -31
- package/clients/eventbridge.d.ts +3 -3
- package/clients/fms.d.ts +9 -1
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +4 -4
- package/dist/aws-sdk.js +219 -214
- package/dist/aws-sdk.min.js +27 -27
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/datasync.d.ts
CHANGED
|
@@ -12,19 +12,19 @@ declare class DataSync extends Service {
|
|
|
12
12
|
constructor(options?: DataSync.Types.ClientConfiguration)
|
|
13
13
|
config: Config & DataSync.Types.ClientConfiguration;
|
|
14
14
|
/**
|
|
15
|
-
* Cancels execution of a task. When you cancel a task execution, the transfer of some files is abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases,
|
|
15
|
+
* Cancels execution of a task. When you cancel a task execution, the transfer of some files is abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully complete the transfer when you start the next task execution.
|
|
16
16
|
*/
|
|
17
17
|
cancelTaskExecution(params: DataSync.Types.CancelTaskExecutionRequest, callback?: (err: AWSError, data: DataSync.Types.CancelTaskExecutionResponse) => void): Request<DataSync.Types.CancelTaskExecutionResponse, AWSError>;
|
|
18
18
|
/**
|
|
19
|
-
* Cancels execution of a task. When you cancel a task execution, the transfer of some files is abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases,
|
|
19
|
+
* Cancels execution of a task. When you cancel a task execution, the transfer of some files is abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully complete the transfer when you start the next task execution.
|
|
20
20
|
*/
|
|
21
21
|
cancelTaskExecution(callback?: (err: AWSError, data: DataSync.Types.CancelTaskExecutionResponse) => void): Request<DataSync.Types.CancelTaskExecutionResponse, AWSError>;
|
|
22
22
|
/**
|
|
23
|
-
* Activates an
|
|
23
|
+
* Activates an DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region. You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet. You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run. Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
|
|
24
24
|
*/
|
|
25
25
|
createAgent(params: DataSync.Types.CreateAgentRequest, callback?: (err: AWSError, data: DataSync.Types.CreateAgentResponse) => void): Request<DataSync.Types.CreateAgentResponse, AWSError>;
|
|
26
26
|
/**
|
|
27
|
-
* Activates an
|
|
27
|
+
* Activates an DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region. You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet. You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run. Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
|
|
28
28
|
*/
|
|
29
29
|
createAgent(callback?: (err: AWSError, data: DataSync.Types.CreateAgentResponse) => void): Request<DataSync.Types.CreateAgentResponse, AWSError>;
|
|
30
30
|
/**
|
|
@@ -60,11 +60,11 @@ declare class DataSync extends Service {
|
|
|
60
60
|
*/
|
|
61
61
|
createLocationObjectStorage(callback?: (err: AWSError, data: DataSync.Types.CreateLocationObjectStorageResponse) => void): Request<DataSync.Types.CreateLocationObjectStorageResponse, AWSError>;
|
|
62
62
|
/**
|
|
63
|
-
* Creates an endpoint for an Amazon S3 bucket. For more information, see
|
|
63
|
+
* Creates an endpoint for an Amazon S3 bucket. For more information, see Create an Amazon S3 location in the DataSync User Guide.
|
|
64
64
|
*/
|
|
65
65
|
createLocationS3(params: DataSync.Types.CreateLocationS3Request, callback?: (err: AWSError, data: DataSync.Types.CreateLocationS3Response) => void): Request<DataSync.Types.CreateLocationS3Response, AWSError>;
|
|
66
66
|
/**
|
|
67
|
-
* Creates an endpoint for an Amazon S3 bucket. For more information, see
|
|
67
|
+
* Creates an endpoint for an Amazon S3 bucket. For more information, see Create an Amazon S3 location in the DataSync User Guide.
|
|
68
68
|
*/
|
|
69
69
|
createLocationS3(callback?: (err: AWSError, data: DataSync.Types.CreateLocationS3Response) => void): Request<DataSync.Types.CreateLocationS3Response, AWSError>;
|
|
70
70
|
/**
|
|
@@ -76,27 +76,27 @@ declare class DataSync extends Service {
|
|
|
76
76
|
*/
|
|
77
77
|
createLocationSmb(callback?: (err: AWSError, data: DataSync.Types.CreateLocationSmbResponse) => void): Request<DataSync.Types.CreateLocationSmbResponse, AWSError>;
|
|
78
78
|
/**
|
|
79
|
-
* Creates a task. A task includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer. When you create a task that transfers data between
|
|
79
|
+
* Creates a task. A task includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer. When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of the two locations that you specify must reside in the Region where DataSync is being used. The other location must be specified in a different Region. You can transfer data between commercial Amazon Web Services Regions except for China, or between Amazon Web Services GovCloud (US) Regions. When you use DataSync to copy files or objects between Amazon Web Services Regions, you pay for data transfer between Regions. This is billed as data transfer OUT from your source Region to your destination Region. For more information, see Data Transfer pricing.
|
|
80
80
|
*/
|
|
81
81
|
createTask(params: DataSync.Types.CreateTaskRequest, callback?: (err: AWSError, data: DataSync.Types.CreateTaskResponse) => void): Request<DataSync.Types.CreateTaskResponse, AWSError>;
|
|
82
82
|
/**
|
|
83
|
-
* Creates a task. A task includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer. When you create a task that transfers data between
|
|
83
|
+
* Creates a task. A task includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer. When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of the two locations that you specify must reside in the Region where DataSync is being used. The other location must be specified in a different Region. You can transfer data between commercial Amazon Web Services Regions except for China, or between Amazon Web Services GovCloud (US) Regions. When you use DataSync to copy files or objects between Amazon Web Services Regions, you pay for data transfer between Regions. This is billed as data transfer OUT from your source Region to your destination Region. For more information, see Data Transfer pricing.
|
|
84
84
|
*/
|
|
85
85
|
createTask(callback?: (err: AWSError, data: DataSync.Types.CreateTaskResponse) => void): Request<DataSync.Types.CreateTaskResponse, AWSError>;
|
|
86
86
|
/**
|
|
87
|
-
* Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your
|
|
87
|
+
* Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
|
|
88
88
|
*/
|
|
89
89
|
deleteAgent(params: DataSync.Types.DeleteAgentRequest, callback?: (err: AWSError, data: DataSync.Types.DeleteAgentResponse) => void): Request<DataSync.Types.DeleteAgentResponse, AWSError>;
|
|
90
90
|
/**
|
|
91
|
-
* Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your
|
|
91
|
+
* Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
|
|
92
92
|
*/
|
|
93
93
|
deleteAgent(callback?: (err: AWSError, data: DataSync.Types.DeleteAgentResponse) => void): Request<DataSync.Types.DeleteAgentResponse, AWSError>;
|
|
94
94
|
/**
|
|
95
|
-
* Deletes the configuration of a location used by
|
|
95
|
+
* Deletes the configuration of a location used by DataSync.
|
|
96
96
|
*/
|
|
97
97
|
deleteLocation(params: DataSync.Types.DeleteLocationRequest, callback?: (err: AWSError, data: DataSync.Types.DeleteLocationResponse) => void): Request<DataSync.Types.DeleteLocationResponse, AWSError>;
|
|
98
98
|
/**
|
|
99
|
-
* Deletes the configuration of a location used by
|
|
99
|
+
* Deletes the configuration of a location used by DataSync.
|
|
100
100
|
*/
|
|
101
101
|
deleteLocation(callback?: (err: AWSError, data: DataSync.Types.DeleteLocationResponse) => void): Request<DataSync.Types.DeleteLocationResponse, AWSError>;
|
|
102
102
|
/**
|
|
@@ -180,11 +180,11 @@ declare class DataSync extends Service {
|
|
|
180
180
|
*/
|
|
181
181
|
describeTaskExecution(callback?: (err: AWSError, data: DataSync.Types.DescribeTaskExecutionResponse) => void): Request<DataSync.Types.DescribeTaskExecutionResponse, AWSError>;
|
|
182
182
|
/**
|
|
183
|
-
* Returns a list of agents owned by an
|
|
183
|
+
* Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN). By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response. If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.
|
|
184
184
|
*/
|
|
185
185
|
listAgents(params: DataSync.Types.ListAgentsRequest, callback?: (err: AWSError, data: DataSync.Types.ListAgentsResponse) => void): Request<DataSync.Types.ListAgentsResponse, AWSError>;
|
|
186
186
|
/**
|
|
187
|
-
* Returns a list of agents owned by an
|
|
187
|
+
* Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN). By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response. If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.
|
|
188
188
|
*/
|
|
189
189
|
listAgents(callback?: (err: AWSError, data: DataSync.Types.ListAgentsResponse) => void): Request<DataSync.Types.ListAgentsResponse, AWSError>;
|
|
190
190
|
/**
|
|
@@ -220,27 +220,27 @@ declare class DataSync extends Service {
|
|
|
220
220
|
*/
|
|
221
221
|
listTasks(callback?: (err: AWSError, data: DataSync.Types.ListTasksResponse) => void): Request<DataSync.Types.ListTasksResponse, AWSError>;
|
|
222
222
|
/**
|
|
223
|
-
* Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time. TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE. For detailed information, see the Task Execution section in the Components and Terminology topic in the
|
|
223
|
+
* Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time. TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE. For detailed information, see the Task Execution section in the Components and Terminology topic in the DataSync User Guide.
|
|
224
224
|
*/
|
|
225
225
|
startTaskExecution(params: DataSync.Types.StartTaskExecutionRequest, callback?: (err: AWSError, data: DataSync.Types.StartTaskExecutionResponse) => void): Request<DataSync.Types.StartTaskExecutionResponse, AWSError>;
|
|
226
226
|
/**
|
|
227
|
-
* Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time. TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE. For detailed information, see the Task Execution section in the Components and Terminology topic in the
|
|
227
|
+
* Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time. TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE. For detailed information, see the Task Execution section in the Components and Terminology topic in the DataSync User Guide.
|
|
228
228
|
*/
|
|
229
229
|
startTaskExecution(callback?: (err: AWSError, data: DataSync.Types.StartTaskExecutionResponse) => void): Request<DataSync.Types.StartTaskExecutionResponse, AWSError>;
|
|
230
230
|
/**
|
|
231
|
-
* Applies a key-value pair to an
|
|
231
|
+
* Applies a key-value pair to an Amazon Web Services resource.
|
|
232
232
|
*/
|
|
233
233
|
tagResource(params: DataSync.Types.TagResourceRequest, callback?: (err: AWSError, data: DataSync.Types.TagResourceResponse) => void): Request<DataSync.Types.TagResourceResponse, AWSError>;
|
|
234
234
|
/**
|
|
235
|
-
* Applies a key-value pair to an
|
|
235
|
+
* Applies a key-value pair to an Amazon Web Services resource.
|
|
236
236
|
*/
|
|
237
237
|
tagResource(callback?: (err: AWSError, data: DataSync.Types.TagResourceResponse) => void): Request<DataSync.Types.TagResourceResponse, AWSError>;
|
|
238
238
|
/**
|
|
239
|
-
* Removes a tag from an
|
|
239
|
+
* Removes a tag from an Amazon Web Services resource.
|
|
240
240
|
*/
|
|
241
241
|
untagResource(params: DataSync.Types.UntagResourceRequest, callback?: (err: AWSError, data: DataSync.Types.UntagResourceResponse) => void): Request<DataSync.Types.UntagResourceResponse, AWSError>;
|
|
242
242
|
/**
|
|
243
|
-
* Removes a tag from an
|
|
243
|
+
* Removes a tag from an Amazon Web Services resource.
|
|
244
244
|
*/
|
|
245
245
|
untagResource(callback?: (err: AWSError, data: DataSync.Types.UntagResourceResponse) => void): Request<DataSync.Types.UntagResourceResponse, AWSError>;
|
|
246
246
|
/**
|
|
@@ -324,7 +324,7 @@ declare namespace DataSync {
|
|
|
324
324
|
}
|
|
325
325
|
export interface CreateAgentRequest {
|
|
326
326
|
/**
|
|
327
|
-
* Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the
|
|
327
|
+
* Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the DataSync console. The redirect URL returned in the response provides you the activation key for your agent in the query string parameter activationKey. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent. For more information, see Activating an Agent in the DataSync User Guide.
|
|
328
328
|
*/
|
|
329
329
|
ActivationKey: ActivationKey;
|
|
330
330
|
/**
|
|
@@ -350,13 +350,13 @@ declare namespace DataSync {
|
|
|
350
350
|
}
|
|
351
351
|
export interface CreateAgentResponse {
|
|
352
352
|
/**
|
|
353
|
-
* The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation to return a list of agents for your account and
|
|
353
|
+
* The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation to return a list of agents for your account and Amazon Web Services Region.
|
|
354
354
|
*/
|
|
355
355
|
AgentArn?: AgentArn;
|
|
356
356
|
}
|
|
357
357
|
export interface CreateLocationEfsRequest {
|
|
358
358
|
/**
|
|
359
|
-
* A subdirectory in the location’s path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. By default,
|
|
359
|
+
* A subdirectory in the location’s path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. By default, DataSync uses the root directory. Subdirectory must be specified with forward slashes. For example, /path/to/folder.
|
|
360
360
|
*/
|
|
361
361
|
Subdirectory?: EfsSubdirectory;
|
|
362
362
|
/**
|
|
@@ -416,15 +416,15 @@ declare namespace DataSync {
|
|
|
416
416
|
}
|
|
417
417
|
export interface CreateLocationNfsRequest {
|
|
418
418
|
/**
|
|
419
|
-
* The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network. To see all the paths exported by your NFS server, run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access. If you are copying data to or from your
|
|
419
|
+
* The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network. To see all the paths exported by your NFS server, run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access. If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information. For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.
|
|
420
420
|
*/
|
|
421
421
|
Subdirectory: NfsSubdirectory;
|
|
422
422
|
/**
|
|
423
|
-
* The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this host name to mount the NFS server in a network. If you are copying data to or from your
|
|
423
|
+
* The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this host name to mount the NFS server in a network. If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information. This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
|
|
424
424
|
*/
|
|
425
425
|
ServerHostname: ServerHostname;
|
|
426
426
|
/**
|
|
427
|
-
* Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server. If you are copying data to or from your
|
|
427
|
+
* Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server. If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.
|
|
428
428
|
*/
|
|
429
429
|
OnPremConfig: OnPremConfig;
|
|
430
430
|
/**
|
|
@@ -492,16 +492,16 @@ declare namespace DataSync {
|
|
|
492
492
|
*/
|
|
493
493
|
Subdirectory?: S3Subdirectory;
|
|
494
494
|
/**
|
|
495
|
-
* The ARN of the Amazon S3 bucket. If the bucket is on an
|
|
495
|
+
* The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.
|
|
496
496
|
*/
|
|
497
497
|
S3BucketArn: S3BucketArn;
|
|
498
498
|
/**
|
|
499
|
-
* The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in
|
|
499
|
+
* The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.
|
|
500
500
|
*/
|
|
501
501
|
S3StorageClass?: S3StorageClass;
|
|
502
502
|
S3Config: S3Config;
|
|
503
503
|
/**
|
|
504
|
-
* If you are using DataSync on an
|
|
504
|
+
* If you are using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.
|
|
505
505
|
*/
|
|
506
506
|
AgentArns?: AgentArnList;
|
|
507
507
|
/**
|
|
@@ -561,7 +561,7 @@ declare namespace DataSync {
|
|
|
561
561
|
*/
|
|
562
562
|
SourceLocationArn: LocationArn;
|
|
563
563
|
/**
|
|
564
|
-
* The Amazon Resource Name (ARN) of an
|
|
564
|
+
* The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.
|
|
565
565
|
*/
|
|
566
566
|
DestinationLocationArn: LocationArn;
|
|
567
567
|
/**
|
|
@@ -588,6 +588,10 @@ declare namespace DataSync {
|
|
|
588
588
|
* The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.
|
|
589
589
|
*/
|
|
590
590
|
Tags?: InputTagList;
|
|
591
|
+
/**
|
|
592
|
+
* A list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe). For example: "/folder1|/folder2"
|
|
593
|
+
*/
|
|
594
|
+
Includes?: FilterList;
|
|
591
595
|
}
|
|
592
596
|
export interface CreateTaskResponse {
|
|
593
597
|
/**
|
|
@@ -597,7 +601,7 @@ declare namespace DataSync {
|
|
|
597
601
|
}
|
|
598
602
|
export interface DeleteAgentRequest {
|
|
599
603
|
/**
|
|
600
|
-
* The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents operation to return a list of agents for your account and
|
|
604
|
+
* The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents operation to return a list of agents for your account and Amazon Web Services Region.
|
|
601
605
|
*/
|
|
602
606
|
AgentArn: AgentArn;
|
|
603
607
|
}
|
|
@@ -790,7 +794,7 @@ declare namespace DataSync {
|
|
|
790
794
|
S3StorageClass?: S3StorageClass;
|
|
791
795
|
S3Config?: S3Config;
|
|
792
796
|
/**
|
|
793
|
-
* If you are using DataSync on an
|
|
797
|
+
* If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.
|
|
794
798
|
*/
|
|
795
799
|
AgentArns?: AgentArnList;
|
|
796
800
|
/**
|
|
@@ -846,7 +850,7 @@ declare namespace DataSync {
|
|
|
846
850
|
*/
|
|
847
851
|
TaskExecutionArn?: TaskExecutionArn;
|
|
848
852
|
/**
|
|
849
|
-
* The status of the task execution. For detailed information about task execution statuses, see Understanding Task Statuses in the
|
|
853
|
+
* The status of the task execution. For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
|
|
850
854
|
*/
|
|
851
855
|
Status?: TaskExecutionStatus;
|
|
852
856
|
Options?: Options;
|
|
@@ -875,7 +879,7 @@ declare namespace DataSync {
|
|
|
875
879
|
*/
|
|
876
880
|
FilesTransferred?: long;
|
|
877
881
|
/**
|
|
878
|
-
* The number of logical bytes written to the destination
|
|
882
|
+
* The number of logical bytes written to the destination Amazon Web Services storage resource.
|
|
879
883
|
*/
|
|
880
884
|
BytesWritten?: long;
|
|
881
885
|
/**
|
|
@@ -899,7 +903,7 @@ declare namespace DataSync {
|
|
|
899
903
|
*/
|
|
900
904
|
TaskArn?: TaskArn;
|
|
901
905
|
/**
|
|
902
|
-
* The status of the task that was described. For detailed information about task execution statuses, see Understanding Task Statuses in the
|
|
906
|
+
* The status of the task that was described. For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
|
|
903
907
|
*/
|
|
904
908
|
Status?: TaskStatus;
|
|
905
909
|
/**
|
|
@@ -915,7 +919,7 @@ declare namespace DataSync {
|
|
|
915
919
|
*/
|
|
916
920
|
SourceLocationArn?: LocationArn;
|
|
917
921
|
/**
|
|
918
|
-
* The Amazon Resource Name (ARN) of the
|
|
922
|
+
* The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.
|
|
919
923
|
*/
|
|
920
924
|
DestinationLocationArn?: LocationArn;
|
|
921
925
|
/**
|
|
@@ -943,7 +947,7 @@ declare namespace DataSync {
|
|
|
943
947
|
*/
|
|
944
948
|
Schedule?: TaskSchedule;
|
|
945
949
|
/**
|
|
946
|
-
* Errors that
|
|
950
|
+
* Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
|
|
947
951
|
*/
|
|
948
952
|
ErrorCode?: string;
|
|
949
953
|
/**
|
|
@@ -954,6 +958,10 @@ declare namespace DataSync {
|
|
|
954
958
|
* The time that the task was created.
|
|
955
959
|
*/
|
|
956
960
|
CreationTime?: Time;
|
|
961
|
+
/**
|
|
962
|
+
* A list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe). For example: "/folder1|/folder2"
|
|
963
|
+
*/
|
|
964
|
+
Includes?: FilterList;
|
|
957
965
|
}
|
|
958
966
|
export type DestinationNetworkInterfaceArns = NetworkInterfaceArn[];
|
|
959
967
|
export type Duration = number;
|
|
@@ -978,7 +986,7 @@ declare namespace DataSync {
|
|
|
978
986
|
export type FilterList = FilterRule[];
|
|
979
987
|
export interface FilterRule {
|
|
980
988
|
/**
|
|
981
|
-
* The type of filter rule to apply.
|
|
989
|
+
* The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.
|
|
982
990
|
*/
|
|
983
991
|
FilterType?: FilterType;
|
|
984
992
|
/**
|
|
@@ -1171,11 +1179,11 @@ declare namespace DataSync {
|
|
|
1171
1179
|
*/
|
|
1172
1180
|
VerifyMode?: VerifyMode;
|
|
1173
1181
|
/**
|
|
1174
|
-
* A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes. Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the
|
|
1182
|
+
* A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes. Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
|
|
1175
1183
|
*/
|
|
1176
1184
|
OverwriteMode?: OverwriteMode;
|
|
1177
1185
|
/**
|
|
1178
|
-
* A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so
|
|
1186
|
+
* A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so DataSync can only do this on a best-effort basis. Default value: BEST_EFFORT. BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended). NONE: Ignore Atime. If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE. If Atime is set to NONE, Mtime must also be NONE.
|
|
1179
1187
|
*/
|
|
1180
1188
|
Atime?: Atime;
|
|
1181
1189
|
/**
|
|
@@ -1191,19 +1199,19 @@ declare namespace DataSync {
|
|
|
1191
1199
|
*/
|
|
1192
1200
|
Gid?: Gid;
|
|
1193
1201
|
/**
|
|
1194
|
-
* A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the
|
|
1202
|
+
* A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide. Default value: PRESERVE. PRESERVE: Ignore such destination files (recommended). REMOVE: Delete destination files that aren’t present in the source.
|
|
1195
1203
|
*/
|
|
1196
1204
|
PreserveDeletedFiles?: PreserveDeletedFiles;
|
|
1197
1205
|
/**
|
|
1198
|
-
* A value that determines whether
|
|
1206
|
+
* A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata. DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker. Default value: NONE. NONE: Ignore special devices (recommended). PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
|
|
1199
1207
|
*/
|
|
1200
1208
|
PreserveDevices?: PreserveDevices;
|
|
1201
1209
|
/**
|
|
1202
|
-
* A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync. Default value: PRESERVE. PRESERVE: Preserve POSIX-style permissions (recommended). NONE: Ignore permissions.
|
|
1210
|
+
* A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync. Default value: PRESERVE. PRESERVE: Preserve POSIX-style permissions (recommended). NONE: Ignore permissions. DataSync can preserve extant permissions of a source location.
|
|
1203
1211
|
*/
|
|
1204
1212
|
PosixPermissions?: PosixPermissions;
|
|
1205
1213
|
/**
|
|
1206
|
-
* A value that limits the bandwidth used by
|
|
1214
|
+
* A value that limits the bandwidth used by DataSync. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).
|
|
1207
1215
|
*/
|
|
1208
1216
|
BytesPerSecond?: BytesPerSecond;
|
|
1209
1217
|
/**
|
|
@@ -1283,6 +1291,10 @@ declare namespace DataSync {
|
|
|
1283
1291
|
* A list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe). For example: "/folder1|/folder2"
|
|
1284
1292
|
*/
|
|
1285
1293
|
Includes?: FilterList;
|
|
1294
|
+
/**
|
|
1295
|
+
* A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".
|
|
1296
|
+
*/
|
|
1297
|
+
Excludes?: FilterList;
|
|
1286
1298
|
}
|
|
1287
1299
|
export interface StartTaskExecutionResponse {
|
|
1288
1300
|
/**
|
|
@@ -1294,11 +1306,11 @@ declare namespace DataSync {
|
|
|
1294
1306
|
export type TagKeyList = TagKey[];
|
|
1295
1307
|
export interface TagListEntry {
|
|
1296
1308
|
/**
|
|
1297
|
-
* The key for an
|
|
1309
|
+
* The key for an Amazon Web Services resource tag.
|
|
1298
1310
|
*/
|
|
1299
1311
|
Key: TagKey;
|
|
1300
1312
|
/**
|
|
1301
|
-
* The value for an
|
|
1313
|
+
* The value for an Amazon Web Services resource tag.
|
|
1302
1314
|
*/
|
|
1303
1315
|
Value?: TagValue;
|
|
1304
1316
|
}
|
|
@@ -1331,7 +1343,7 @@ declare namespace DataSync {
|
|
|
1331
1343
|
}
|
|
1332
1344
|
export interface TaskExecutionResultDetail {
|
|
1333
1345
|
/**
|
|
1334
|
-
* The total time in milliseconds that
|
|
1346
|
+
* The total time in milliseconds that DataSync spent in the PREPARING phase.
|
|
1335
1347
|
*/
|
|
1336
1348
|
PrepareDuration?: Duration;
|
|
1337
1349
|
/**
|
|
@@ -1339,11 +1351,11 @@ declare namespace DataSync {
|
|
|
1339
1351
|
*/
|
|
1340
1352
|
PrepareStatus?: PhaseStatus;
|
|
1341
1353
|
/**
|
|
1342
|
-
* The total time in milliseconds that
|
|
1354
|
+
* The total time in milliseconds that DataSync took to transfer the file from the source to the destination location.
|
|
1343
1355
|
*/
|
|
1344
1356
|
TotalDuration?: Duration;
|
|
1345
1357
|
/**
|
|
1346
|
-
* The total time in milliseconds that
|
|
1358
|
+
* The total time in milliseconds that DataSync spent in the TRANSFERRING phase.
|
|
1347
1359
|
*/
|
|
1348
1360
|
TransferDuration?: Duration;
|
|
1349
1361
|
/**
|
|
@@ -1351,7 +1363,7 @@ declare namespace DataSync {
|
|
|
1351
1363
|
*/
|
|
1352
1364
|
TransferStatus?: PhaseStatus;
|
|
1353
1365
|
/**
|
|
1354
|
-
* The total time in milliseconds that
|
|
1366
|
+
* The total time in milliseconds that DataSync spent in the VERIFYING phase.
|
|
1355
1367
|
*/
|
|
1356
1368
|
VerifyDuration?: Duration;
|
|
1357
1369
|
/**
|
|
@@ -1359,7 +1371,7 @@ declare namespace DataSync {
|
|
|
1359
1371
|
*/
|
|
1360
1372
|
VerifyStatus?: PhaseStatus;
|
|
1361
1373
|
/**
|
|
1362
|
-
* Errors that
|
|
1374
|
+
* Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
|
|
1363
1375
|
*/
|
|
1364
1376
|
ErrorCode?: string;
|
|
1365
1377
|
/**
|
|
@@ -1402,7 +1414,7 @@ declare namespace DataSync {
|
|
|
1402
1414
|
export type TaskQueueing = "ENABLED"|"DISABLED"|string;
|
|
1403
1415
|
export interface TaskSchedule {
|
|
1404
1416
|
/**
|
|
1405
|
-
* A cron expression that specifies when
|
|
1417
|
+
* A cron expression that specifies when DataSync initiates a scheduled transfer from a source to a destination location.
|
|
1406
1418
|
*/
|
|
1407
1419
|
ScheduleExpression: ScheduleExpressionCron;
|
|
1408
1420
|
}
|
|
@@ -1440,7 +1452,7 @@ declare namespace DataSync {
|
|
|
1440
1452
|
*/
|
|
1441
1453
|
LocationArn: LocationArn;
|
|
1442
1454
|
/**
|
|
1443
|
-
* The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network. To see all the paths exported by your NFS server, run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. To transfer all the data in the folder that you specified, DataSync must have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the files you want DataSync to access have permissions that allow read access for all users. Doing either option enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access. If you are copying data to or from your
|
|
1455
|
+
* The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network. To see all the paths exported by your NFS server, run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. To transfer all the data in the folder that you specified, DataSync must have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the files you want DataSync to access have permissions that allow read access for all users. Doing either option enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access. If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information. For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.
|
|
1444
1456
|
*/
|
|
1445
1457
|
Subdirectory?: NfsSubdirectory;
|
|
1446
1458
|
OnPremConfig?: OnPremConfig;
|
|
@@ -1540,6 +1552,10 @@ declare namespace DataSync {
|
|
|
1540
1552
|
* The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup.
|
|
1541
1553
|
*/
|
|
1542
1554
|
CloudWatchLogGroupArn?: LogGroupArn;
|
|
1555
|
+
/**
|
|
1556
|
+
* A list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe). For example: "/folder1|/folder2"
|
|
1557
|
+
*/
|
|
1558
|
+
Includes?: FilterList;
|
|
1543
1559
|
}
|
|
1544
1560
|
export interface UpdateTaskResponse {
|
|
1545
1561
|
}
|