@aws-sdk/client-datasync 3.316.0 → 3.320.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/README.md +113 -8
- package/dist-cjs/DataSync.js +26 -0
- package/dist-cjs/commands/AddStorageSystemCommand.js +46 -0
- package/dist-cjs/commands/DescribeDiscoveryJobCommand.js +45 -0
- package/dist-cjs/commands/DescribeStorageSystemCommand.js +45 -0
- package/dist-cjs/commands/DescribeStorageSystemResourceMetricsCommand.js +45 -0
- package/dist-cjs/commands/DescribeStorageSystemResourcesCommand.js +45 -0
- package/dist-cjs/commands/GenerateRecommendationsCommand.js +45 -0
- package/dist-cjs/commands/ListDiscoveryJobsCommand.js +45 -0
- package/dist-cjs/commands/ListStorageSystemsCommand.js +45 -0
- package/dist-cjs/commands/RemoveStorageSystemCommand.js +45 -0
- package/dist-cjs/commands/StartDiscoveryJobCommand.js +45 -0
- package/dist-cjs/commands/StopDiscoveryJobCommand.js +45 -0
- package/dist-cjs/commands/UpdateDiscoveryJobCommand.js +45 -0
- package/dist-cjs/commands/UpdateStorageSystemCommand.js +46 -0
- package/dist-cjs/commands/index.js +13 -0
- package/dist-cjs/models/models_0.js +56 -8
- package/dist-cjs/pagination/DescribeStorageSystemResourceMetricsPaginator.js +29 -0
- package/dist-cjs/pagination/DescribeStorageSystemResourcesPaginator.js +29 -0
- package/dist-cjs/pagination/ListDiscoveryJobsPaginator.js +29 -0
- package/dist-cjs/pagination/ListStorageSystemsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +4 -0
- package/dist-cjs/protocols/Aws_json1_1.js +948 -87
- package/dist-es/DataSync.js +26 -0
- package/dist-es/commands/AddStorageSystemCommand.js +42 -0
- package/dist-es/commands/DescribeDiscoveryJobCommand.js +41 -0
- package/dist-es/commands/DescribeStorageSystemCommand.js +41 -0
- package/dist-es/commands/DescribeStorageSystemResourceMetricsCommand.js +41 -0
- package/dist-es/commands/DescribeStorageSystemResourcesCommand.js +41 -0
- package/dist-es/commands/GenerateRecommendationsCommand.js +41 -0
- package/dist-es/commands/ListDiscoveryJobsCommand.js +41 -0
- package/dist-es/commands/ListStorageSystemsCommand.js +41 -0
- package/dist-es/commands/RemoveStorageSystemCommand.js +41 -0
- package/dist-es/commands/StartDiscoveryJobCommand.js +41 -0
- package/dist-es/commands/StopDiscoveryJobCommand.js +41 -0
- package/dist-es/commands/UpdateDiscoveryJobCommand.js +41 -0
- package/dist-es/commands/UpdateStorageSystemCommand.js +42 -0
- package/dist-es/commands/index.js +13 -0
- package/dist-es/models/models_0.js +51 -7
- package/dist-es/pagination/DescribeStorageSystemResourceMetricsPaginator.js +25 -0
- package/dist-es/pagination/DescribeStorageSystemResourcesPaginator.js +25 -0
- package/dist-es/pagination/ListDiscoveryJobsPaginator.js +25 -0
- package/dist-es/pagination/ListStorageSystemsPaginator.js +25 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +908 -74
- package/dist-types/DataSync.d.ts +94 -2
- package/dist-types/DataSyncClient.d.ts +18 -4
- package/dist-types/commands/AddStorageSystemCommand.d.ts +91 -0
- package/dist-types/commands/CancelTaskExecutionCommand.d.ts +4 -3
- package/dist-types/commands/CreateAgentCommand.d.ts +4 -3
- package/dist-types/commands/CreateLocationEfsCommand.d.ts +2 -1
- package/dist-types/commands/CreateLocationFsxLustreCommand.d.ts +2 -1
- package/dist-types/commands/CreateLocationFsxOntapCommand.d.ts +3 -3
- package/dist-types/commands/CreateLocationFsxOpenZfsCommand.d.ts +4 -4
- package/dist-types/commands/CreateLocationFsxWindowsCommand.d.ts +2 -1
- package/dist-types/commands/CreateLocationHdfsCommand.d.ts +2 -1
- package/dist-types/commands/CreateLocationNfsCommand.d.ts +2 -1
- package/dist-types/commands/CreateLocationObjectStorageCommand.d.ts +5 -2
- package/dist-types/commands/CreateLocationS3Command.d.ts +20 -3
- package/dist-types/commands/CreateLocationSmbCommand.d.ts +2 -1
- package/dist-types/commands/CreateTaskCommand.d.ts +8 -1
- package/dist-types/commands/DeleteAgentCommand.d.ts +4 -4
- package/dist-types/commands/DeleteLocationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTaskCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAgentCommand.d.ts +4 -2
- package/dist-types/commands/DescribeDiscoveryJobCommand.d.ts +70 -0
- package/dist-types/commands/DescribeLocationEfsCommand.d.ts +4 -2
- package/dist-types/commands/DescribeLocationFsxLustreCommand.d.ts +2 -1
- package/dist-types/commands/DescribeLocationFsxOntapCommand.d.ts +2 -1
- package/dist-types/commands/DescribeLocationFsxOpenZfsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeLocationFsxWindowsCommand.d.ts +4 -3
- package/dist-types/commands/DescribeLocationHdfsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeLocationNfsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeLocationObjectStorageCommand.d.ts +4 -2
- package/dist-types/commands/DescribeLocationS3Command.d.ts +2 -1
- package/dist-types/commands/DescribeLocationSmbCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStorageSystemCommand.d.ts +71 -0
- package/dist-types/commands/DescribeStorageSystemResourceMetricsCommand.d.ts +77 -0
- package/dist-types/commands/DescribeStorageSystemResourcesCommand.d.ts +82 -0
- package/dist-types/commands/DescribeTaskCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTaskExecutionCommand.d.ts +2 -1
- package/dist-types/commands/GenerateRecommendationsCommand.d.ts +82 -0
- package/dist-types/commands/ListAgentsCommand.d.ts +2 -1
- package/dist-types/commands/ListDiscoveryJobsCommand.d.ts +73 -0
- package/dist-types/commands/ListLocationsCommand.d.ts +2 -1
- package/dist-types/commands/ListStorageSystemsCommand.d.ts +71 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListTaskExecutionsCommand.d.ts +2 -1
- package/dist-types/commands/ListTasksCommand.d.ts +2 -1
- package/dist-types/commands/RemoveStorageSystemCommand.d.ts +71 -0
- package/dist-types/commands/StartDiscoveryJobCommand.d.ts +80 -0
- package/dist-types/commands/StartTaskExecutionCommand.d.ts +10 -2
- package/dist-types/commands/StopDiscoveryJobCommand.d.ts +73 -0
- package/dist-types/commands/TagResourceCommand.d.ts +6 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAgentCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDiscoveryJobCommand.d.ts +71 -0
- package/dist-types/commands/UpdateLocationHdfsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateLocationNfsCommand.d.ts +5 -3
- package/dist-types/commands/UpdateLocationObjectStorageCommand.d.ts +2 -1
- package/dist-types/commands/UpdateLocationSmbCommand.d.ts +4 -3
- package/dist-types/commands/UpdateStorageSystemCommand.d.ts +84 -0
- package/dist-types/commands/UpdateTaskCommand.d.ts +2 -1
- package/dist-types/commands/UpdateTaskExecutionCommand.d.ts +7 -7
- package/dist-types/commands/index.d.ts +13 -0
- package/dist-types/models/models_0.d.ts +1429 -296
- package/dist-types/pagination/DescribeStorageSystemResourceMetricsPaginator.d.ts +7 -0
- package/dist-types/pagination/DescribeStorageSystemResourcesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDiscoveryJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListStorageSystemsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +117 -0
- package/dist-types/ts3.4/DataSync.d.ts +227 -0
- package/dist-types/ts3.4/DataSyncClient.d.ts +78 -0
- package/dist-types/ts3.4/commands/AddStorageSystemCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/DescribeDiscoveryJobCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeStorageSystemCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeStorageSystemResourceMetricsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeStorageSystemResourcesCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GenerateRecommendationsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListDiscoveryJobsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListStorageSystemsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/RemoveStorageSystemCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StartDiscoveryJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StopDiscoveryJobCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/UpdateDiscoveryJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateStorageSystemCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +13 -0
- package/dist-types/ts3.4/models/models_0.d.ts +302 -18
- package/dist-types/ts3.4/pagination/DescribeStorageSystemResourceMetricsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/DescribeStorageSystemResourcesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDiscoveryJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListStorageSystemsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +156 -0
- package/package.json +8 -6
|
@@ -1,5 +1,153 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { DataSyncServiceException as __BaseException } from "./DataSyncServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* <p>The credentials that provide DataSync Discovery read access to your on-premises storage system's
|
|
6
|
+
* management interface.</p>
|
|
7
|
+
* <p>DataSync Discovery stores these credentials in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>. For more
|
|
8
|
+
* information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-configure-storage.html">Accessing your on-premises
|
|
9
|
+
* storage system</a>.</p>
|
|
10
|
+
*/
|
|
11
|
+
export interface Credentials {
|
|
12
|
+
/**
|
|
13
|
+
* <p>Specifies the user name for your storage system's management interface.</p>
|
|
14
|
+
*/
|
|
15
|
+
Username: string | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* <p>Specifies the password for your storage system's management interface.</p>
|
|
18
|
+
*/
|
|
19
|
+
Password: string | undefined;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* @public
|
|
23
|
+
* <p>The network settings that DataSync Discovery uses to connect with your on-premises storage system's
|
|
24
|
+
* management interface.</p>
|
|
25
|
+
*/
|
|
26
|
+
export interface DiscoveryServerConfiguration {
|
|
27
|
+
/**
|
|
28
|
+
* <p>The domain name or IP address of your storage system's management interface.</p>
|
|
29
|
+
*/
|
|
30
|
+
ServerHostname: string | undefined;
|
|
31
|
+
/**
|
|
32
|
+
* <p>The network port for accessing the storage system's management interface.</p>
|
|
33
|
+
*/
|
|
34
|
+
ServerPort?: number;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* @public
|
|
38
|
+
* @enum
|
|
39
|
+
*/
|
|
40
|
+
export declare const DiscoverySystemType: {
|
|
41
|
+
readonly NetAppONTAP: "NetAppONTAP";
|
|
42
|
+
};
|
|
43
|
+
/**
|
|
44
|
+
* @public
|
|
45
|
+
*/
|
|
46
|
+
export type DiscoverySystemType = (typeof DiscoverySystemType)[keyof typeof DiscoverySystemType];
|
|
47
|
+
/**
|
|
48
|
+
* @public
|
|
49
|
+
* <p>A key-value pair representing a single tag that's been applied to an Amazon Web Services
|
|
50
|
+
* resource.</p>
|
|
51
|
+
*/
|
|
52
|
+
export interface TagListEntry {
|
|
53
|
+
/**
|
|
54
|
+
* <p>The key for an Amazon Web Services resource tag.</p>
|
|
55
|
+
*/
|
|
56
|
+
Key: string | undefined;
|
|
57
|
+
/**
|
|
58
|
+
* <p>The value for an Amazon Web Services resource tag.</p>
|
|
59
|
+
*/
|
|
60
|
+
Value?: string;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
export interface AddStorageSystemRequest {
|
|
66
|
+
/**
|
|
67
|
+
* <p>Specifies the server name and network port required to connect with the management
|
|
68
|
+
* interface of your on-premises storage system.</p>
|
|
69
|
+
*/
|
|
70
|
+
ServerConfiguration: DiscoveryServerConfiguration | undefined;
|
|
71
|
+
/**
|
|
72
|
+
* <p>Specifies the type of on-premises storage system that you want DataSync Discovery to collect
|
|
73
|
+
* information about.</p>
|
|
74
|
+
* <note>
|
|
75
|
+
* <p>DataSync Discovery currently supports NetApp
|
|
76
|
+
* Fabric-Attached
|
|
77
|
+
* Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or
|
|
78
|
+
* later.</p>
|
|
79
|
+
* </note>
|
|
80
|
+
*/
|
|
81
|
+
SystemType: DiscoverySystemType | string | undefined;
|
|
82
|
+
/**
|
|
83
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to
|
|
84
|
+
* and reads from your on-premises storage system's management interface.</p>
|
|
85
|
+
*/
|
|
86
|
+
AgentArns: string[] | undefined;
|
|
87
|
+
/**
|
|
88
|
+
* <p>Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging
|
|
89
|
+
* discovery job events.</p>
|
|
90
|
+
*/
|
|
91
|
+
CloudWatchLogGroupArn?: string;
|
|
92
|
+
/**
|
|
93
|
+
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
|
|
94
|
+
* resources. We recommend creating at least a name tag for your on-premises storage
|
|
95
|
+
* system.</p>
|
|
96
|
+
*/
|
|
97
|
+
Tags?: TagListEntry[];
|
|
98
|
+
/**
|
|
99
|
+
* <p>Specifies a familiar name for your on-premises storage system.</p>
|
|
100
|
+
*/
|
|
101
|
+
Name?: string;
|
|
102
|
+
/**
|
|
103
|
+
* <p>Specifies a client token to make sure requests with this API operation are idempotent. If
|
|
104
|
+
* you don't specify a client token, DataSync generates one for you
|
|
105
|
+
* automatically.</p>
|
|
106
|
+
*/
|
|
107
|
+
ClientToken?: string;
|
|
108
|
+
/**
|
|
109
|
+
* <p>Specifies the user name and password for accessing your on-premises storage system's
|
|
110
|
+
* management interface.</p>
|
|
111
|
+
*/
|
|
112
|
+
Credentials: Credentials | undefined;
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
export interface AddStorageSystemResponse {
|
|
118
|
+
/**
|
|
119
|
+
* <p>The ARN of the on-premises storage system that you can use with DataSync Discovery.</p>
|
|
120
|
+
*/
|
|
121
|
+
StorageSystemArn: string | undefined;
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* @public
|
|
125
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
126
|
+
* service.</p>
|
|
127
|
+
*/
|
|
128
|
+
export declare class InternalException extends __BaseException {
|
|
129
|
+
readonly name: "InternalException";
|
|
130
|
+
readonly $fault: "server";
|
|
131
|
+
errorCode?: string;
|
|
132
|
+
/**
|
|
133
|
+
* @internal
|
|
134
|
+
*/
|
|
135
|
+
constructor(opts: __ExceptionOptionType<InternalException, __BaseException>);
|
|
136
|
+
}
|
|
137
|
+
/**
|
|
138
|
+
* @public
|
|
139
|
+
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
140
|
+
*/
|
|
141
|
+
export declare class InvalidRequestException extends __BaseException {
|
|
142
|
+
readonly name: "InvalidRequestException";
|
|
143
|
+
readonly $fault: "client";
|
|
144
|
+
errorCode?: string;
|
|
145
|
+
datasyncErrorCode?: string;
|
|
146
|
+
/**
|
|
147
|
+
* @internal
|
|
148
|
+
*/
|
|
149
|
+
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
150
|
+
}
|
|
3
151
|
/**
|
|
4
152
|
* @public
|
|
5
153
|
* @enum
|
|
@@ -27,7 +175,8 @@ export interface AgentListEntry {
|
|
|
27
175
|
*/
|
|
28
176
|
Name?: string;
|
|
29
177
|
/**
|
|
30
|
-
* <p>The status of an agent. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/understand-agent-statuses.html">DataSync agent
|
|
178
|
+
* <p>The status of an agent. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/understand-agent-statuses.html">DataSync agent
|
|
179
|
+
* statuses</a>.</p>
|
|
31
180
|
*/
|
|
32
181
|
Status?: AgentStatus | string;
|
|
33
182
|
}
|
|
@@ -60,45 +209,23 @@ export interface CancelTaskExecutionResponse {
|
|
|
60
209
|
}
|
|
61
210
|
/**
|
|
62
211
|
* @public
|
|
63
|
-
* <p>
|
|
64
|
-
|
|
65
|
-
export declare class InternalException extends __BaseException {
|
|
66
|
-
readonly name: "InternalException";
|
|
67
|
-
readonly $fault: "server";
|
|
68
|
-
errorCode?: string;
|
|
69
|
-
/**
|
|
70
|
-
* @internal
|
|
71
|
-
*/
|
|
72
|
-
constructor(opts: __ExceptionOptionType<InternalException, __BaseException>);
|
|
73
|
-
}
|
|
74
|
-
/**
|
|
75
|
-
* @public
|
|
76
|
-
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
212
|
+
* <p>The storage capacity of an on-premises storage system resource (for example, a
|
|
213
|
+
* volume).</p>
|
|
77
214
|
*/
|
|
78
|
-
export
|
|
79
|
-
readonly name: "InvalidRequestException";
|
|
80
|
-
readonly $fault: "client";
|
|
81
|
-
errorCode?: string;
|
|
82
|
-
datasyncErrorCode?: string;
|
|
215
|
+
export interface Capacity {
|
|
83
216
|
/**
|
|
84
|
-
*
|
|
217
|
+
* <p>The amount of space that's being used in a storage system resource.</p>
|
|
85
218
|
*/
|
|
86
|
-
|
|
87
|
-
}
|
|
88
|
-
/**
|
|
89
|
-
* @public
|
|
90
|
-
* <p>A key-value pair representing a single tag that's been applied to an Amazon Web Services
|
|
91
|
-
* resource.</p>
|
|
92
|
-
*/
|
|
93
|
-
export interface TagListEntry {
|
|
219
|
+
Used?: number;
|
|
94
220
|
/**
|
|
95
|
-
* <p>The
|
|
221
|
+
* <p>The total amount of space available in a storage system resource.</p>
|
|
96
222
|
*/
|
|
97
|
-
|
|
223
|
+
Provisioned?: number;
|
|
98
224
|
/**
|
|
99
|
-
* <p>The
|
|
225
|
+
* <p>The amount of space that's being used in a storage system resource without accounting for
|
|
226
|
+
* compression or deduplication.</p>
|
|
100
227
|
*/
|
|
101
|
-
|
|
228
|
+
LogicalUsed?: number;
|
|
102
229
|
}
|
|
103
230
|
/**
|
|
104
231
|
* @public
|
|
@@ -113,8 +240,7 @@ export interface CreateAgentRequest {
|
|
|
113
240
|
* agent in the query string parameter <code>activationKey</code>. It might also include other
|
|
114
241
|
* activation-related parameters; however, these are merely defaults. The arguments you pass to
|
|
115
242
|
* this API call determine the actual configuration of your agent.</p>
|
|
116
|
-
* <p>For more information, see Activating an Agent in the <i>DataSync
|
|
117
|
-
* User Guide.</i>
|
|
243
|
+
* <p>For more information, see Activating an Agent in the <i>DataSync User Guide.</i>
|
|
118
244
|
* </p>
|
|
119
245
|
*/
|
|
120
246
|
ActivationKey: string | undefined;
|
|
@@ -136,21 +262,22 @@ export interface CreateAgentRequest {
|
|
|
136
262
|
/**
|
|
137
263
|
* <p>The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is
|
|
138
264
|
* the client-side VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC
|
|
139
|
-
* endpoint, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html#create-endpoint-service">Creating a VPC
|
|
265
|
+
* endpoint, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html#create-endpoint-service">Creating a VPC
|
|
266
|
+
* Endpoint Service Configuration</a> in the Amazon VPC User Guide.</p>
|
|
140
267
|
* <p>VPC endpoint ID looks like this: <code>vpce-01234d5aff67890e1</code>.</p>
|
|
141
268
|
*/
|
|
142
269
|
VpcEndpointId?: string;
|
|
143
270
|
/**
|
|
144
|
-
* <p>The Amazon Resource Names (ARNs) of the subnets in which DataSync will create
|
|
145
|
-
* network interfaces for each data transfer task. The agent that runs a task must be
|
|
146
|
-
* When you start a task that is associated with an agent created in a VPC, or one that
|
|
147
|
-
* access to an IP address in a VPC, then the task is also private. In this case, DataSync
|
|
148
|
-
*
|
|
149
|
-
* agent must be able to route to all these four network interfaces.</p>
|
|
271
|
+
* <p>The Amazon Resource Names (ARNs) of the subnets in which DataSync will create
|
|
272
|
+
* elastic network interfaces for each data transfer task. The agent that runs a task must be
|
|
273
|
+
* private. When you start a task that is associated with an agent created in a VPC, or one that
|
|
274
|
+
* has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For a data transfer
|
|
275
|
+
* to work, the agent must be able to route to all these four network interfaces.</p>
|
|
150
276
|
*/
|
|
151
277
|
SubnetArns?: string[];
|
|
152
278
|
/**
|
|
153
|
-
* <p>The ARNs of the security groups used to protect your data transfer task subnets. See
|
|
279
|
+
* <p>The ARNs of the security groups used to protect your data transfer task subnets. See
|
|
280
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns">SecurityGroupArns</a>.</p>
|
|
154
281
|
*/
|
|
155
282
|
SecurityGroupArns?: string[];
|
|
156
283
|
}
|
|
@@ -178,8 +305,8 @@ export interface Ec2Config {
|
|
|
178
305
|
* <p>In the same virtual private cloud (VPC) as the Amazon EFS file system.</p>
|
|
179
306
|
* </li>
|
|
180
307
|
* <li>
|
|
181
|
-
* <p>In the same Availability Zone as at least one mount target for the Amazon EFS
|
|
182
|
-
* system.</p>
|
|
308
|
+
* <p>In the same Availability Zone as at least one mount target for the Amazon EFS
|
|
309
|
+
* file system.</p>
|
|
183
310
|
* </li>
|
|
184
311
|
* </ul>
|
|
185
312
|
* <note>
|
|
@@ -211,10 +338,12 @@ export type EfsInTransitEncryption = (typeof EfsInTransitEncryption)[keyof typeo
|
|
|
211
338
|
*/
|
|
212
339
|
export interface CreateLocationEfsRequest {
|
|
213
340
|
/**
|
|
214
|
-
* <p>Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location).
|
|
341
|
+
* <p>Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location).
|
|
342
|
+
* By default, DataSync uses the root directory, but you can also include
|
|
343
|
+
* subdirectories.</p>
|
|
215
344
|
* <note>
|
|
216
345
|
* <p>You must specify a value with forward slashes (for example,
|
|
217
|
-
*
|
|
346
|
+
* <code>/path/to/folder</code>).</p>
|
|
218
347
|
* </note>
|
|
219
348
|
*/
|
|
220
349
|
Subdirectory?: string;
|
|
@@ -233,7 +362,8 @@ export interface CreateLocationEfsRequest {
|
|
|
233
362
|
*/
|
|
234
363
|
Tags?: TagListEntry[];
|
|
235
364
|
/**
|
|
236
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses
|
|
365
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses
|
|
366
|
+
* to access the Amazon EFS file system.</p>
|
|
237
367
|
*/
|
|
238
368
|
AccessPointArn?: string;
|
|
239
369
|
/**
|
|
@@ -242,8 +372,8 @@ export interface CreateLocationEfsRequest {
|
|
|
242
372
|
*/
|
|
243
373
|
FileSystemAccessRoleArn?: string;
|
|
244
374
|
/**
|
|
245
|
-
* <p>Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2
|
|
246
|
-
* or from the Amazon EFS file system.</p>
|
|
375
|
+
* <p>Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2
|
|
376
|
+
* encryption when it copies data to or from the Amazon EFS file system.</p>
|
|
247
377
|
* <p>If you specify an access point using <code>AccessPointArn</code> or an IAM
|
|
248
378
|
* role using <code>FileSystemAccessRoleArn</code>, you must set this parameter to
|
|
249
379
|
* <code>TLS1_2</code>.</p>
|
|
@@ -270,15 +400,20 @@ export interface CreateLocationFsxLustreRequest {
|
|
|
270
400
|
*/
|
|
271
401
|
FsxFilesystemArn: string | undefined;
|
|
272
402
|
/**
|
|
273
|
-
* <p>The Amazon Resource Names (ARNs) of the security groups that are used to configure the
|
|
403
|
+
* <p>The Amazon Resource Names (ARNs) of the security groups that are used to configure the
|
|
404
|
+
* FSx for Lustre file system.</p>
|
|
274
405
|
*/
|
|
275
406
|
SecurityGroupArns: string[] | undefined;
|
|
276
407
|
/**
|
|
277
|
-
* <p>A subdirectory in the location's path. This subdirectory in the FSx for Lustre
|
|
408
|
+
* <p>A subdirectory in the location's path. This subdirectory in the FSx for Lustre
|
|
409
|
+
* file system is used to read data from the FSx for Lustre source location or write
|
|
410
|
+
* data to the FSx for Lustre destination.</p>
|
|
278
411
|
*/
|
|
279
412
|
Subdirectory?: string;
|
|
280
413
|
/**
|
|
281
|
-
* <p>The key-value pair that represents a tag that you want to add to the resource. The value
|
|
414
|
+
* <p>The key-value pair that represents a tag that you want to add to the resource. The value
|
|
415
|
+
* can be an empty string. This value helps you manage, filter, and search for your resources. We
|
|
416
|
+
* recommend that you create a name tag for your location.</p>
|
|
282
417
|
*/
|
|
283
418
|
Tags?: TagListEntry[];
|
|
284
419
|
}
|
|
@@ -312,7 +447,8 @@ export type NfsVersion = (typeof NfsVersion)[keyof typeof NfsVersion];
|
|
|
312
447
|
*/
|
|
313
448
|
export interface NfsMountOptions {
|
|
314
449
|
/**
|
|
315
|
-
* <p>Specifies the NFS version that you want DataSync to use when mounting your NFS
|
|
450
|
+
* <p>Specifies the NFS version that you want DataSync to use when mounting your NFS
|
|
451
|
+
* share. If the server refuses to use the version specified, the task fails.</p>
|
|
316
452
|
* <p>You can specify the following options:</p>
|
|
317
453
|
* <ul>
|
|
318
454
|
* <li>
|
|
@@ -321,8 +457,8 @@ export interface NfsMountOptions {
|
|
|
321
457
|
* </li>
|
|
322
458
|
* <li>
|
|
323
459
|
* <p>
|
|
324
|
-
* <code>NFS3</code>: Stateless protocol version that allows for asynchronous
|
|
325
|
-
*
|
|
460
|
+
* <code>NFS3</code>: Stateless protocol version that allows for asynchronous writes on
|
|
461
|
+
* the server.</p>
|
|
326
462
|
* </li>
|
|
327
463
|
* <li>
|
|
328
464
|
* <p>
|
|
@@ -331,9 +467,9 @@ export interface NfsMountOptions {
|
|
|
331
467
|
* </li>
|
|
332
468
|
* <li>
|
|
333
469
|
* <p>
|
|
334
|
-
* <code>NFSv4_1</code>: Stateful protocol version that supports sessions,
|
|
335
|
-
*
|
|
336
|
-
*
|
|
470
|
+
* <code>NFSv4_1</code>: Stateful protocol version that supports sessions, directory
|
|
471
|
+
* delegations, and parallel data processing. NFS version 4.1 also includes all features
|
|
472
|
+
* available in version 4.0.</p>
|
|
337
473
|
* </li>
|
|
338
474
|
* </ul>
|
|
339
475
|
* <note>
|
|
@@ -344,7 +480,9 @@ export interface NfsMountOptions {
|
|
|
344
480
|
}
|
|
345
481
|
/**
|
|
346
482
|
* @public
|
|
347
|
-
* <p>Specifies the Network File System (NFS) protocol configuration that DataSync
|
|
483
|
+
* <p>Specifies the Network File System (NFS) protocol configuration that DataSync
|
|
484
|
+
* uses to access your Amazon FSx for OpenZFS or Amazon FSx for NetApp ONTAP file
|
|
485
|
+
* system.</p>
|
|
348
486
|
*/
|
|
349
487
|
export interface FsxProtocolNfs {
|
|
350
488
|
/**
|
|
@@ -381,16 +519,16 @@ export interface SmbMountOptions {
|
|
|
381
519
|
* <ul>
|
|
382
520
|
* <li>
|
|
383
521
|
* <p>
|
|
384
|
-
* <code>AUTOMATIC</code> (default): DataSync and the SMB file server negotiate
|
|
385
|
-
*
|
|
386
|
-
* and later.)</p>
|
|
522
|
+
* <code>AUTOMATIC</code> (default): DataSync and the SMB file server negotiate
|
|
523
|
+
* the highest version of SMB that they mutually support between 2.1 and 3.1.1.</p>
|
|
387
524
|
* <p>This is the recommended option. If you instead choose a specific version that your
|
|
388
525
|
* file server doesn't support, you may get an <code>Operation Not Supported</code>
|
|
389
526
|
* error.</p>
|
|
390
527
|
* </li>
|
|
391
528
|
* <li>
|
|
392
529
|
* <p>
|
|
393
|
-
* <code>SMB3</code>: Restricts the protocol negotiation to only SMB version
|
|
530
|
+
* <code>SMB3</code>: Restricts the protocol negotiation to only SMB version
|
|
531
|
+
* 3.0.2.</p>
|
|
394
532
|
* </li>
|
|
395
533
|
* <li>
|
|
396
534
|
* <p>
|
|
@@ -398,7 +536,8 @@ export interface SmbMountOptions {
|
|
|
398
536
|
* </li>
|
|
399
537
|
* <li>
|
|
400
538
|
* <p>
|
|
401
|
-
* <code>SMB2_0</code>: Restricts the protocol negotiation to only SMB version
|
|
539
|
+
* <code>SMB2_0</code>: Restricts the protocol negotiation to only SMB version
|
|
540
|
+
* 2.0.</p>
|
|
402
541
|
* </li>
|
|
403
542
|
* <li>
|
|
404
543
|
* <p>
|
|
@@ -413,11 +552,13 @@ export interface SmbMountOptions {
|
|
|
413
552
|
}
|
|
414
553
|
/**
|
|
415
554
|
* @public
|
|
416
|
-
* <p>Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system. For more information, see
|
|
555
|
+
* <p>Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system. For more information, see
|
|
556
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access">Accessing FSx for ONTAP file systems</a>.</p>
|
|
417
557
|
*/
|
|
418
558
|
export interface FsxProtocolSmb {
|
|
419
559
|
/**
|
|
420
|
-
* <p>Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that
|
|
560
|
+
* <p>Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that
|
|
561
|
+
* your storage virtual machine (SVM) belongs to.</p>
|
|
421
562
|
*/
|
|
422
563
|
Domain?: string;
|
|
423
564
|
/**
|
|
@@ -429,13 +570,13 @@ export interface FsxProtocolSmb {
|
|
|
429
570
|
*/
|
|
430
571
|
Password: string | undefined;
|
|
431
572
|
/**
|
|
432
|
-
* <p>Specifies a user name that can mount the location and access the files, folders, and
|
|
573
|
+
* <p>Specifies a user name that can mount the location and access the files, folders, and
|
|
574
|
+
* metadata that you need in the SVM.</p>
|
|
433
575
|
* <p>If you provide a user in your Active Directory, note the following:</p>
|
|
434
576
|
* <ul>
|
|
435
577
|
* <li>
|
|
436
|
-
* <p>If you're using Directory Service for Microsoft Active Directory, the user
|
|
437
|
-
*
|
|
438
|
-
* FSx Administrators group.</p>
|
|
578
|
+
* <p>If you're using Directory Service for Microsoft Active Directory, the user must be a member of the
|
|
579
|
+
* Amazon Web Services Delegated FSx Administrators group.</p>
|
|
439
580
|
* </li>
|
|
440
581
|
* <li>
|
|
441
582
|
* <p>If you're using a self-managed Active Directory, the user must be a member of either
|
|
@@ -443,26 +584,19 @@ export interface FsxProtocolSmb {
|
|
|
443
584
|
* administration when you created your file system.</p>
|
|
444
585
|
* </li>
|
|
445
586
|
* </ul>
|
|
446
|
-
* <p>Make sure that the user has the permissions it needs
|
|
447
|
-
* to copy the data you want:</p>
|
|
587
|
+
* <p>Make sure that the user has the permissions it needs to copy the data you want:</p>
|
|
448
588
|
* <ul>
|
|
449
589
|
* <li>
|
|
450
590
|
* <p>
|
|
451
|
-
* <code>SE_TCB_NAME</code>: Required to
|
|
452
|
-
*
|
|
453
|
-
* privilege, you also can copy NTFS discretionary
|
|
454
|
-
* access lists (DACLs).</p>
|
|
591
|
+
* <code>SE_TCB_NAME</code>: Required to set object ownership and file metadata. With
|
|
592
|
+
* this privilege, you also can copy NTFS discretionary access lists (DACLs).</p>
|
|
455
593
|
* </li>
|
|
456
594
|
* <li>
|
|
457
595
|
* <p>
|
|
458
|
-
* <code>SE_SECURITY_NAME</code>: May be
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
-
*
|
|
462
|
-
* the Domain Admins group. If
|
|
463
|
-
* you configure your task to copy SACLs, make sure
|
|
464
|
-
* that the user has the required privileges. For
|
|
465
|
-
* information about copying SACLs, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions">Ownership and permissions-related options</a>.</p>
|
|
596
|
+
* <code>SE_SECURITY_NAME</code>: May be needed to copy NTFS system access control lists
|
|
597
|
+
* (SACLs). This operation specifically requires the Windows privilege, which is granted to
|
|
598
|
+
* members of the Domain Admins group. If you configure your task to copy SACLs, make sure
|
|
599
|
+
* that the user has the required privileges. For information about copying SACLs, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions">Ownership and permissions-related options</a>.</p>
|
|
466
600
|
* </li>
|
|
467
601
|
* </ul>
|
|
468
602
|
*/
|
|
@@ -470,15 +604,19 @@ export interface FsxProtocolSmb {
|
|
|
470
604
|
}
|
|
471
605
|
/**
|
|
472
606
|
* @public
|
|
473
|
-
* <p>Specifies the data transfer protocol that DataSync uses to access your
|
|
607
|
+
* <p>Specifies the data transfer protocol that DataSync uses to access your
|
|
608
|
+
* Amazon FSx file system.</p>
|
|
474
609
|
*/
|
|
475
610
|
export interface FsxProtocol {
|
|
476
611
|
/**
|
|
477
|
-
* <p>Specifies the Network File System (NFS) protocol configuration that DataSync
|
|
612
|
+
* <p>Specifies the Network File System (NFS) protocol configuration that DataSync
|
|
613
|
+
* uses to access your FSx for OpenZFS file system or FSx for ONTAP file
|
|
614
|
+
* system's storage virtual machine (SVM).</p>
|
|
478
615
|
*/
|
|
479
616
|
NFS?: FsxProtocolNfs;
|
|
480
617
|
/**
|
|
481
|
-
* <p>Specifies the Server Message Block (SMB) protocol configuration that DataSync
|
|
618
|
+
* <p>Specifies the Server Message Block (SMB) protocol configuration that DataSync
|
|
619
|
+
* uses to access your FSx for ONTAP file system's SVM.</p>
|
|
482
620
|
*/
|
|
483
621
|
SMB?: FsxProtocolSmb;
|
|
484
622
|
}
|
|
@@ -487,11 +625,13 @@ export interface FsxProtocol {
|
|
|
487
625
|
*/
|
|
488
626
|
export interface CreateLocationFsxOntapRequest {
|
|
489
627
|
/**
|
|
490
|
-
* <p>Specifies the data transfer protocol that DataSync uses to access your
|
|
628
|
+
* <p>Specifies the data transfer protocol that DataSync uses to access your
|
|
629
|
+
* Amazon FSx file system.</p>
|
|
491
630
|
*/
|
|
492
631
|
Protocol: FsxProtocol | undefined;
|
|
493
632
|
/**
|
|
494
|
-
* <p>Specifies the Amazon EC2 security groups that provide access to your file system's
|
|
633
|
+
* <p>Specifies the Amazon EC2 security groups that provide access to your file system's
|
|
634
|
+
* preferred subnet.</p>
|
|
495
635
|
* <p>The security groups must allow outbound traffic on the following ports (depending on the
|
|
496
636
|
* protocol you use):</p>
|
|
497
637
|
* <ul>
|
|
@@ -520,14 +660,13 @@ export interface CreateLocationFsxOntapRequest {
|
|
|
520
660
|
* shares), or share name (for SMB file shares). For example, your mount path might be
|
|
521
661
|
* <code>/vol1</code>, <code>/vol1/tree1</code>, or <code>/share1</code>.</p>
|
|
522
662
|
* <note>
|
|
523
|
-
* <p>Don't specify a junction path in the SVM's root volume. For more
|
|
524
|
-
* information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html">Managing FSx for ONTAP
|
|
525
|
-
* storage virtual machines</a> in the <i>Amazon FSx for NetApp ONTAP User Guide</i>.</p>
|
|
663
|
+
* <p>Don't specify a junction path in the SVM's root volume. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html">Managing FSx for ONTAP storage virtual machines</a> in the <i>Amazon FSx for NetApp ONTAP User Guide</i>.</p>
|
|
526
664
|
* </note>
|
|
527
665
|
*/
|
|
528
666
|
Subdirectory?: string;
|
|
529
667
|
/**
|
|
530
|
-
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
|
|
668
|
+
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
|
|
669
|
+
* resources. We recommend creating at least a name tag for your location.</p>
|
|
531
670
|
*/
|
|
532
671
|
Tags?: TagListEntry[];
|
|
533
672
|
}
|
|
@@ -536,7 +675,8 @@ export interface CreateLocationFsxOntapRequest {
|
|
|
536
675
|
*/
|
|
537
676
|
export interface CreateLocationFsxOntapResponse {
|
|
538
677
|
/**
|
|
539
|
-
* <p>Specifies the ARN of the FSx for ONTAP file system location that you
|
|
678
|
+
* <p>Specifies the ARN of the FSx for ONTAP file system location that you
|
|
679
|
+
* create.</p>
|
|
540
680
|
*/
|
|
541
681
|
LocationArn?: string;
|
|
542
682
|
}
|
|
@@ -549,23 +689,23 @@ export interface CreateLocationFsxOpenZfsRequest {
|
|
|
549
689
|
*/
|
|
550
690
|
FsxFilesystemArn: string | undefined;
|
|
551
691
|
/**
|
|
552
|
-
* <p>The type of protocol that DataSync uses to
|
|
553
|
-
* access your file system.</p>
|
|
692
|
+
* <p>The type of protocol that DataSync uses to access your file system.</p>
|
|
554
693
|
*/
|
|
555
694
|
Protocol: FsxProtocol | undefined;
|
|
556
695
|
/**
|
|
557
|
-
* <p>The ARNs of the security groups that are used to configure the
|
|
558
|
-
*
|
|
696
|
+
* <p>The ARNs of the security groups that are used to configure the FSx for OpenZFS file
|
|
697
|
+
* system.</p>
|
|
559
698
|
*/
|
|
560
699
|
SecurityGroupArns: string[] | undefined;
|
|
561
700
|
/**
|
|
562
|
-
* <p>A subdirectory in the location's path that must begin with <code>/fsx</code>. DataSync uses this subdirectory to read
|
|
563
|
-
*
|
|
564
|
-
* location).</p>
|
|
701
|
+
* <p>A subdirectory in the location's path that must begin with <code>/fsx</code>. DataSync uses this subdirectory to read or write data (depending on whether the file
|
|
702
|
+
* system is a source or destination location).</p>
|
|
565
703
|
*/
|
|
566
704
|
Subdirectory?: string;
|
|
567
705
|
/**
|
|
568
|
-
* <p>The key-value pair that represents a tag that you want to add to the resource. The value
|
|
706
|
+
* <p>The key-value pair that represents a tag that you want to add to the resource. The value
|
|
707
|
+
* can be an empty string. This value helps you manage, filter, and search for your resources. We
|
|
708
|
+
* recommend that you create a name tag for your location.</p>
|
|
569
709
|
*/
|
|
570
710
|
Tags?: TagListEntry[];
|
|
571
711
|
}
|
|
@@ -583,8 +723,8 @@ export interface CreateLocationFsxOpenZfsResponse {
|
|
|
583
723
|
*/
|
|
584
724
|
export interface CreateLocationFsxWindowsRequest {
|
|
585
725
|
/**
|
|
586
|
-
* <p>Specifies a mount path for your file system using forward slashes. This is where DataSync reads or
|
|
587
|
-
*
|
|
726
|
+
* <p>Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination
|
|
727
|
+
* location).</p>
|
|
588
728
|
*/
|
|
589
729
|
Subdirectory?: string;
|
|
590
730
|
/**
|
|
@@ -596,24 +736,23 @@ export interface CreateLocationFsxWindowsRequest {
|
|
|
596
736
|
* <p>Specifies the ARNs of the security groups that provide access to your file system's
|
|
597
737
|
* preferred subnet.</p>
|
|
598
738
|
* <note>
|
|
599
|
-
* <p>If you choose a security group that doesn't allow connections from within
|
|
600
|
-
*
|
|
739
|
+
* <p>If you choose a security group that doesn't allow connections from within itself, do one
|
|
740
|
+
* of the following:</p>
|
|
601
741
|
* <ul>
|
|
602
742
|
* <li>
|
|
603
|
-
* <p>Configure the security group to allow it to communicate within
|
|
604
|
-
* itself.</p>
|
|
743
|
+
* <p>Configure the security group to allow it to communicate within itself.</p>
|
|
605
744
|
* </li>
|
|
606
745
|
* <li>
|
|
607
|
-
* <p>Choose a different security group that can communicate with the
|
|
608
|
-
*
|
|
746
|
+
* <p>Choose a different security group that can communicate with the mount target's
|
|
747
|
+
* security group.</p>
|
|
609
748
|
* </li>
|
|
610
749
|
* </ul>
|
|
611
750
|
* </note>
|
|
612
751
|
*/
|
|
613
752
|
SecurityGroupArns: string[] | undefined;
|
|
614
753
|
/**
|
|
615
|
-
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
|
|
616
|
-
* recommend creating at least a name tag for your location.</p>
|
|
754
|
+
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
|
|
755
|
+
* resources. We recommend creating at least a name tag for your location.</p>
|
|
617
756
|
*/
|
|
618
757
|
Tags?: TagListEntry[];
|
|
619
758
|
/**
|
|
@@ -851,10 +990,11 @@ export interface CreateLocationNfsRequest {
|
|
|
851
990
|
* <p>To transfer all the data in the folder you specified, DataSync needs to have
|
|
852
991
|
* permissions to read all the data. To ensure this, either configure the NFS export with
|
|
853
992
|
* <code>no_root_squash,</code> or ensure that the permissions for all of the files that you
|
|
854
|
-
* want DataSync allow read access for all users. Doing either enables the agent to
|
|
855
|
-
* files. For the agent to access directories, you must additionally enable all execute
|
|
993
|
+
* want DataSync allow read access for all users. Doing either enables the agent to
|
|
994
|
+
* read the files. For the agent to access directories, you must additionally enable all execute
|
|
856
995
|
* access.</p>
|
|
857
|
-
* <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
|
|
996
|
+
* <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
|
|
997
|
+
* Snowcone</a> for more information.</p>
|
|
858
998
|
* <p>For information about NFS export configuration, see 18.7. The /etc/exports
|
|
859
999
|
* Configuration File in the Red Hat Enterprise Linux documentation.</p>
|
|
860
1000
|
*/
|
|
@@ -863,7 +1003,8 @@ export interface CreateLocationNfsRequest {
|
|
|
863
1003
|
* <p>The name of the NFS server. This value is the IP address or Domain Name Service (DNS)
|
|
864
1004
|
* name of the NFS server. An agent that is installed on-premises uses this hostname to mount the
|
|
865
1005
|
* NFS server in a network. </p>
|
|
866
|
-
* <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
|
|
1006
|
+
* <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
|
|
1007
|
+
* Snowcone</a> for more information.</p>
|
|
867
1008
|
* <note>
|
|
868
1009
|
* <p>This name must either be DNS-compliant or must be an IP version 4 (IPv4)
|
|
869
1010
|
* address.</p>
|
|
@@ -873,7 +1014,8 @@ export interface CreateLocationNfsRequest {
|
|
|
873
1014
|
/**
|
|
874
1015
|
* <p>Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to
|
|
875
1016
|
* an NFS server. </p>
|
|
876
|
-
* <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
|
|
1017
|
+
* <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
|
|
1018
|
+
* Snowcone</a> for more information.</p>
|
|
877
1019
|
*/
|
|
878
1020
|
OnPremConfig: OnPremConfig | undefined;
|
|
879
1021
|
/**
|
|
@@ -915,12 +1057,13 @@ export type ObjectStorageServerProtocol = (typeof ObjectStorageServerProtocol)[k
|
|
|
915
1057
|
*/
|
|
916
1058
|
export interface CreateLocationObjectStorageRequest {
|
|
917
1059
|
/**
|
|
918
|
-
* <p>Specifies the domain name or IP address of the object storage server. A DataSync
|
|
919
|
-
* object storage server in a network.</p>
|
|
1060
|
+
* <p>Specifies the domain name or IP address of the object storage server. A DataSync
|
|
1061
|
+
* agent uses this hostname to mount the object storage server in a network.</p>
|
|
920
1062
|
*/
|
|
921
1063
|
ServerHostname: string | undefined;
|
|
922
1064
|
/**
|
|
923
|
-
* <p>Specifies the port that your object storage server accepts inbound network traffic on (for
|
|
1065
|
+
* <p>Specifies the port that your object storage server accepts inbound network traffic on (for
|
|
1066
|
+
* example, port 443).</p>
|
|
924
1067
|
*/
|
|
925
1068
|
ServerPort?: number;
|
|
926
1069
|
/**
|
|
@@ -928,7 +1071,9 @@ export interface CreateLocationObjectStorageRequest {
|
|
|
928
1071
|
*/
|
|
929
1072
|
ServerProtocol?: ObjectStorageServerProtocol | string;
|
|
930
1073
|
/**
|
|
931
|
-
* <p>Specifies the object prefix for your object storage server. If this is a source location,
|
|
1074
|
+
* <p>Specifies the object prefix for your object storage server. If this is a source location,
|
|
1075
|
+
* DataSync only copies objects with this prefix. If this is a destination location,
|
|
1076
|
+
* DataSync writes all objects with this prefix. </p>
|
|
932
1077
|
*/
|
|
933
1078
|
Subdirectory?: string;
|
|
934
1079
|
/**
|
|
@@ -936,25 +1081,31 @@ export interface CreateLocationObjectStorageRequest {
|
|
|
936
1081
|
*/
|
|
937
1082
|
BucketName: string | undefined;
|
|
938
1083
|
/**
|
|
939
|
-
* <p>Specifies the access key (for example, a user name) if credentials are required to
|
|
1084
|
+
* <p>Specifies the access key (for example, a user name) if credentials are required to
|
|
1085
|
+
* authenticate with the object storage server.</p>
|
|
940
1086
|
*/
|
|
941
1087
|
AccessKey?: string;
|
|
942
1088
|
/**
|
|
943
|
-
* <p>Specifies the secret key (for example, a password) if credentials are required to
|
|
1089
|
+
* <p>Specifies the secret key (for example, a password) if credentials are required to
|
|
1090
|
+
* authenticate with the object storage server.</p>
|
|
944
1091
|
*/
|
|
945
1092
|
SecretKey?: string;
|
|
946
1093
|
/**
|
|
947
|
-
* <p>Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can
|
|
1094
|
+
* <p>Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can
|
|
1095
|
+
* securely connect with your location.</p>
|
|
948
1096
|
*/
|
|
949
1097
|
AgentArns: string[] | undefined;
|
|
950
1098
|
/**
|
|
951
|
-
* <p>Specifies the key-value pair that represents a tag that you want to add to the resource.
|
|
1099
|
+
* <p>Specifies the key-value pair that represents a tag that you want to add to the resource.
|
|
1100
|
+
* Tags can help you manage, filter, and search for your resources. We recommend creating a name
|
|
1101
|
+
* tag for your location.</p>
|
|
952
1102
|
*/
|
|
953
1103
|
Tags?: TagListEntry[];
|
|
954
1104
|
/**
|
|
955
1105
|
* <p>Specifies a certificate to authenticate with an object storage system that uses a private
|
|
956
1106
|
* or self-signed certificate authority (CA). You must specify a Base64-encoded <code>.pem</code>
|
|
957
|
-
* file (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>). The
|
|
1107
|
+
* file (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>). The
|
|
1108
|
+
* certificate can be up to 32768 bytes (before Base64 encoding).</p>
|
|
958
1109
|
* <p>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</p>
|
|
959
1110
|
*/
|
|
960
1111
|
ServerCertificate?: Uint8Array;
|
|
@@ -1011,16 +1162,17 @@ export interface CreateLocationS3Request {
|
|
|
1011
1162
|
*/
|
|
1012
1163
|
Subdirectory?: string;
|
|
1013
1164
|
/**
|
|
1014
|
-
* <p>The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost,
|
|
1015
|
-
* access point ARN.</p>
|
|
1165
|
+
* <p>The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost,
|
|
1166
|
+
* this must be an access point ARN.</p>
|
|
1016
1167
|
*/
|
|
1017
1168
|
S3BucketArn: string | undefined;
|
|
1018
1169
|
/**
|
|
1019
1170
|
* <p>The Amazon S3 storage class that you want to store your files in when this location is
|
|
1020
|
-
* used as a task destination. For buckets in Amazon Web Services Regions, the storage class
|
|
1021
|
-
* For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.</p>
|
|
1171
|
+
* used as a task destination. For buckets in Amazon Web Services Regions, the storage class
|
|
1172
|
+
* defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.</p>
|
|
1022
1173
|
* <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
|
|
1023
|
-
* 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
|
|
1174
|
+
* 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
|
|
1175
|
+
* when working with S3 storage classes in DataSync</a>.</p>
|
|
1024
1176
|
*/
|
|
1025
1177
|
S3StorageClass?: S3StorageClass | string;
|
|
1026
1178
|
/**
|
|
@@ -1105,8 +1257,8 @@ export interface CreateLocationSmbRequest {
|
|
|
1105
1257
|
*/
|
|
1106
1258
|
MountOptions?: SmbMountOptions;
|
|
1107
1259
|
/**
|
|
1108
|
-
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
|
|
1109
|
-
* recommend creating at least a name tag for your location.</p>
|
|
1260
|
+
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
|
|
1261
|
+
* resources. We recommend creating at least a name tag for your location.</p>
|
|
1110
1262
|
*/
|
|
1111
1263
|
Tags?: TagListEntry[];
|
|
1112
1264
|
}
|
|
@@ -1138,16 +1290,15 @@ export type FilterType = (typeof FilterType)[keyof typeof FilterType];
|
|
|
1138
1290
|
*/
|
|
1139
1291
|
export interface FilterRule {
|
|
1140
1292
|
/**
|
|
1141
|
-
* <p>The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN
|
|
1142
|
-
* type.</p>
|
|
1293
|
+
* <p>The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN
|
|
1294
|
+
* rule type.</p>
|
|
1143
1295
|
*/
|
|
1144
1296
|
FilterType?: FilterType | string;
|
|
1145
1297
|
/**
|
|
1146
1298
|
* <p>A single filter string that consists of the patterns to include or exclude. The patterns
|
|
1147
1299
|
* are delimited by "|" (that is, a pipe), for example: <code>/folder1|/folder2</code>
|
|
1148
1300
|
* </p>
|
|
1149
|
-
* <p>
|
|
1150
|
-
* </p>
|
|
1301
|
+
* <p> </p>
|
|
1151
1302
|
*/
|
|
1152
1303
|
Value?: string;
|
|
1153
1304
|
}
|
|
@@ -1324,14 +1475,15 @@ export type VerifyMode = (typeof VerifyMode)[keyof typeof VerifyMode];
|
|
|
1324
1475
|
*/
|
|
1325
1476
|
export interface Options {
|
|
1326
1477
|
/**
|
|
1327
|
-
* <p>Specifies how and when DataSync
|
|
1478
|
+
* <p>Specifies how and when DataSync checks the integrity of your data during a
|
|
1328
1479
|
* transfer. </p>
|
|
1329
1480
|
* <p>Default value: <code>POINT_IN_TIME_CONSISTENT</code>
|
|
1330
1481
|
* </p>
|
|
1331
1482
|
* <p>
|
|
1332
|
-
* <code>ONLY_FILES_TRANSFERRED</code> (recommended): DataSync calculates the
|
|
1333
|
-
* transferred files and metadata at the source location. At the end of the transfer,
|
|
1334
|
-
*
|
|
1483
|
+
* <code>ONLY_FILES_TRANSFERRED</code> (recommended): DataSync calculates the
|
|
1484
|
+
* checksum of transferred files and metadata at the source location. At the end of the transfer,
|
|
1485
|
+
* DataSync then compares this checksum to the checksum calculated on those files at
|
|
1486
|
+
* the destination.</p>
|
|
1335
1487
|
* <p>We recommend this option when transferring to S3 Glacier Flexible Retrieval or
|
|
1336
1488
|
* S3 Glacier Deep Archive storage classes. For more information, see
|
|
1337
1489
|
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Storage class
|
|
@@ -1486,13 +1638,13 @@ export interface Options {
|
|
|
1486
1638
|
* <p>Specifies whether tasks should be queued before executing the tasks. The default is
|
|
1487
1639
|
* <code>ENABLED</code>, which means the tasks will be queued.</p>
|
|
1488
1640
|
* <p>If you use the same agent to run multiple tasks, you can enable the tasks to run in
|
|
1489
|
-
* series. For more information, see
|
|
1490
|
-
*
|
|
1641
|
+
* series. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution">Queueing task
|
|
1642
|
+
* executions</a>.</p>
|
|
1491
1643
|
*/
|
|
1492
1644
|
TaskQueueing?: TaskQueueing | string;
|
|
1493
1645
|
/**
|
|
1494
|
-
* <p>Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs
|
|
1495
|
-
* 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>
|
|
1646
|
+
* <p>Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs
|
|
1647
|
+
* log 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>
|
|
1496
1648
|
* <p>If you set <code>LogLevel</code> to <code>OFF</code>, no logs are published.
|
|
1497
1649
|
* <code>BASIC</code> publishes logs on errors for individual files transferred.
|
|
1498
1650
|
* <code>TRANSFER</code> publishes logs for every file or object that is transferred and
|
|
@@ -1526,8 +1678,8 @@ export interface Options {
|
|
|
1526
1678
|
* <p>The object owner.</p>
|
|
1527
1679
|
* </li>
|
|
1528
1680
|
* <li>
|
|
1529
|
-
* <p>NTFS discretionary access control lists (DACLs), which determine whether to
|
|
1530
|
-
*
|
|
1681
|
+
* <p>NTFS discretionary access control lists (DACLs), which determine whether to grant
|
|
1682
|
+
* access to an object.</p>
|
|
1531
1683
|
* <p>DataSync won't copy NTFS system access control lists (SACLs) with this
|
|
1532
1684
|
* option.</p>
|
|
1533
1685
|
* </li>
|
|
@@ -1540,14 +1692,15 @@ export interface Options {
|
|
|
1540
1692
|
* <p>The object owner.</p>
|
|
1541
1693
|
* </li>
|
|
1542
1694
|
* <li>
|
|
1543
|
-
* <p>NTFS discretionary access control lists (DACLs), which determine whether to
|
|
1544
|
-
*
|
|
1695
|
+
* <p>NTFS discretionary access control lists (DACLs), which determine whether to grant
|
|
1696
|
+
* access to an object.</p>
|
|
1545
1697
|
* </li>
|
|
1546
1698
|
* <li>
|
|
1547
|
-
* <p>SACLs, which are used by administrators to log attempts to access a secured
|
|
1699
|
+
* <p>SACLs, which are used by administrators to log attempts to access a secured
|
|
1700
|
+
* object.</p>
|
|
1548
1701
|
* <p>Copying SACLs requires granting additional permissions to the Windows user that
|
|
1549
|
-
*
|
|
1550
|
-
* ensures sufficient permissions to files, folders, and metadata, see <a href="create-smb-location.html#SMBuser">user</a>.</p>
|
|
1702
|
+
* DataSync uses to access your SMB location. For information about choosing a
|
|
1703
|
+
* user that ensures sufficient permissions to files, folders, and metadata, see <a href="create-smb-location.html#SMBuser">user</a>.</p>
|
|
1551
1704
|
* </li>
|
|
1552
1705
|
* </ul>
|
|
1553
1706
|
* <p>
|
|
@@ -1568,12 +1721,13 @@ export interface Options {
|
|
|
1568
1721
|
/**
|
|
1569
1722
|
* @public
|
|
1570
1723
|
* <p>Specifies the schedule you want your task to use for repeated executions. For more
|
|
1571
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html">Schedule Expressions for
|
|
1724
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html">Schedule Expressions for
|
|
1725
|
+
* Rules</a>.</p>
|
|
1572
1726
|
*/
|
|
1573
1727
|
export interface TaskSchedule {
|
|
1574
1728
|
/**
|
|
1575
|
-
* <p>A cron expression that specifies when DataSync initiates a scheduled
|
|
1576
|
-
* source to a destination location. </p>
|
|
1729
|
+
* <p>A cron expression that specifies when DataSync initiates a scheduled
|
|
1730
|
+
* transfer from a source to a destination location. </p>
|
|
1577
1731
|
*/
|
|
1578
1732
|
ScheduleExpression: string | undefined;
|
|
1579
1733
|
}
|
|
@@ -1587,7 +1741,8 @@ export interface CreateTaskRequest {
|
|
|
1587
1741
|
*/
|
|
1588
1742
|
SourceLocationArn: string | undefined;
|
|
1589
1743
|
/**
|
|
1590
|
-
* <p>The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.
|
|
1744
|
+
* <p>The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.
|
|
1745
|
+
* </p>
|
|
1591
1746
|
*/
|
|
1592
1747
|
DestinationLocationArn: string | undefined;
|
|
1593
1748
|
/**
|
|
@@ -1601,7 +1756,8 @@ export interface CreateTaskRequest {
|
|
|
1601
1756
|
*/
|
|
1602
1757
|
Name?: string;
|
|
1603
1758
|
/**
|
|
1604
|
-
* <p>Specifies the configuration options for a task. Some options include preserving file or
|
|
1759
|
+
* <p>Specifies the configuration options for a task. Some options include preserving file or
|
|
1760
|
+
* object metadata and verifying data integrity.</p>
|
|
1605
1761
|
* <p>You can also override these options before starting an individual run of a task (also
|
|
1606
1762
|
* 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>
|
|
1607
1763
|
*/
|
|
@@ -1613,7 +1769,8 @@ export interface CreateTaskRequest {
|
|
|
1613
1769
|
Excludes?: FilterRule[];
|
|
1614
1770
|
/**
|
|
1615
1771
|
* <p>Specifies a schedule used to periodically transfer files from a source to a destination
|
|
1616
|
-
* location. The schedule should be specified in UTC time. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your
|
|
1772
|
+
* location. The schedule should be specified in UTC time. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your
|
|
1773
|
+
* task</a>.</p>
|
|
1617
1774
|
*/
|
|
1618
1775
|
Schedule?: TaskSchedule;
|
|
1619
1776
|
/**
|
|
@@ -1625,7 +1782,8 @@ export interface CreateTaskRequest {
|
|
|
1625
1782
|
*/
|
|
1626
1783
|
Tags?: TagListEntry[];
|
|
1627
1784
|
/**
|
|
1628
|
-
* <p>Specifies a list of filter rules that include specific data during your transfer. For more
|
|
1785
|
+
* <p>Specifies a list of filter rules that include specific data during your transfer. For more
|
|
1786
|
+
* information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
1629
1787
|
*/
|
|
1630
1788
|
Includes?: FilterRule[];
|
|
1631
1789
|
}
|
|
@@ -1691,7 +1849,8 @@ export interface DeleteTaskResponse {
|
|
|
1691
1849
|
*/
|
|
1692
1850
|
export interface DescribeAgentRequest {
|
|
1693
1851
|
/**
|
|
1694
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent to
|
|
1852
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent to
|
|
1853
|
+
* describe.</p>
|
|
1695
1854
|
*/
|
|
1696
1855
|
AgentArn: string | undefined;
|
|
1697
1856
|
}
|
|
@@ -1776,13 +1935,70 @@ export interface DescribeAgentResponse {
|
|
|
1776
1935
|
*/
|
|
1777
1936
|
PrivateLinkConfig?: PrivateLinkConfig;
|
|
1778
1937
|
}
|
|
1938
|
+
/**
|
|
1939
|
+
* @public
|
|
1940
|
+
*/
|
|
1941
|
+
export interface DescribeDiscoveryJobRequest {
|
|
1942
|
+
/**
|
|
1943
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the discovery job that you want information
|
|
1944
|
+
* about.</p>
|
|
1945
|
+
*/
|
|
1946
|
+
DiscoveryJobArn: string | undefined;
|
|
1947
|
+
}
|
|
1948
|
+
/**
|
|
1949
|
+
* @public
|
|
1950
|
+
* @enum
|
|
1951
|
+
*/
|
|
1952
|
+
export declare const DiscoveryJobStatus: {
|
|
1953
|
+
readonly COMPLETED: "COMPLETED";
|
|
1954
|
+
readonly COMPLETED_WITH_ISSUES: "COMPLETED_WITH_ISSUES";
|
|
1955
|
+
readonly FAILED: "FAILED";
|
|
1956
|
+
readonly RUNNING: "RUNNING";
|
|
1957
|
+
readonly STOPPED: "STOPPED";
|
|
1958
|
+
readonly TERMINATED: "TERMINATED";
|
|
1959
|
+
readonly WARNING: "WARNING";
|
|
1960
|
+
};
|
|
1961
|
+
/**
|
|
1962
|
+
* @public
|
|
1963
|
+
*/
|
|
1964
|
+
export type DiscoveryJobStatus = (typeof DiscoveryJobStatus)[keyof typeof DiscoveryJobStatus];
|
|
1965
|
+
/**
|
|
1966
|
+
* @public
|
|
1967
|
+
*/
|
|
1968
|
+
export interface DescribeDiscoveryJobResponse {
|
|
1969
|
+
/**
|
|
1970
|
+
* <p>The ARN of the on-premises storage system you're running the discovery job on.</p>
|
|
1971
|
+
*/
|
|
1972
|
+
StorageSystemArn?: string;
|
|
1973
|
+
/**
|
|
1974
|
+
* <p>The ARN of the discovery job.</p>
|
|
1975
|
+
*/
|
|
1976
|
+
DiscoveryJobArn?: string;
|
|
1977
|
+
/**
|
|
1978
|
+
* <p>The number of minutes that the discovery job runs.</p>
|
|
1979
|
+
*/
|
|
1980
|
+
CollectionDurationMinutes?: number;
|
|
1981
|
+
/**
|
|
1982
|
+
* <p>Indicates the status of a discovery job. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table">Discovery job statuses</a>.</p>
|
|
1983
|
+
*/
|
|
1984
|
+
Status?: DiscoveryJobStatus | string;
|
|
1985
|
+
/**
|
|
1986
|
+
* <p>The time when the discovery job started.</p>
|
|
1987
|
+
*/
|
|
1988
|
+
JobStartTime?: Date;
|
|
1989
|
+
/**
|
|
1990
|
+
* <p>The time when the discovery job ended.</p>
|
|
1991
|
+
*/
|
|
1992
|
+
JobEndTime?: Date;
|
|
1993
|
+
}
|
|
1779
1994
|
/**
|
|
1780
1995
|
* @public
|
|
1781
1996
|
* <p>DescribeLocationEfsRequest</p>
|
|
1782
1997
|
*/
|
|
1783
1998
|
export interface DescribeLocationEfsRequest {
|
|
1784
1999
|
/**
|
|
1785
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon EFS file system location that you
|
|
2000
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon EFS file system location that you
|
|
2001
|
+
* want information about.</p>
|
|
1786
2002
|
*/
|
|
1787
2003
|
LocationArn: string | undefined;
|
|
1788
2004
|
}
|
|
@@ -1808,11 +2024,13 @@ export interface DescribeLocationEfsResponse {
|
|
|
1808
2024
|
*/
|
|
1809
2025
|
CreationTime?: Date;
|
|
1810
2026
|
/**
|
|
1811
|
-
* <p>The ARN of the access point that DataSync uses to access the Amazon EFS
|
|
2027
|
+
* <p>The ARN of the access point that DataSync uses to access the Amazon EFS
|
|
2028
|
+
* file system.</p>
|
|
1812
2029
|
*/
|
|
1813
2030
|
AccessPointArn?: string;
|
|
1814
2031
|
/**
|
|
1815
|
-
* <p>The Identity and Access Management (IAM) role that DataSync assumes when
|
|
2032
|
+
* <p>The Identity and Access Management (IAM) role that DataSync assumes when
|
|
2033
|
+
* mounting the Amazon EFS file system.</p>
|
|
1816
2034
|
*/
|
|
1817
2035
|
FileSystemAccessRoleArn?: string;
|
|
1818
2036
|
/**
|
|
@@ -1826,7 +2044,8 @@ export interface DescribeLocationEfsResponse {
|
|
|
1826
2044
|
*/
|
|
1827
2045
|
export interface DescribeLocationFsxLustreRequest {
|
|
1828
2046
|
/**
|
|
1829
|
-
* <p>The Amazon Resource Name (ARN) of the FSx for Lustre location to describe.
|
|
2047
|
+
* <p>The Amazon Resource Name (ARN) of the FSx for Lustre location to describe.
|
|
2048
|
+
* </p>
|
|
1830
2049
|
*/
|
|
1831
2050
|
LocationArn: string | undefined;
|
|
1832
2051
|
}
|
|
@@ -1835,7 +2054,8 @@ export interface DescribeLocationFsxLustreRequest {
|
|
|
1835
2054
|
*/
|
|
1836
2055
|
export interface DescribeLocationFsxLustreResponse {
|
|
1837
2056
|
/**
|
|
1838
|
-
* <p>The Amazon Resource Name (ARN) of the FSx for Lustre location that was
|
|
2057
|
+
* <p>The Amazon Resource Name (ARN) of the FSx for Lustre location that was
|
|
2058
|
+
* described.</p>
|
|
1839
2059
|
*/
|
|
1840
2060
|
LocationArn?: string;
|
|
1841
2061
|
/**
|
|
@@ -1843,7 +2063,8 @@ export interface DescribeLocationFsxLustreResponse {
|
|
|
1843
2063
|
*/
|
|
1844
2064
|
LocationUri?: string;
|
|
1845
2065
|
/**
|
|
1846
|
-
* <p>The Amazon Resource Names (ARNs) of the security groups that are configured for the
|
|
2066
|
+
* <p>The Amazon Resource Names (ARNs) of the security groups that are configured for the
|
|
2067
|
+
* FSx for Lustre file system.</p>
|
|
1847
2068
|
*/
|
|
1848
2069
|
SecurityGroupArns?: string[];
|
|
1849
2070
|
/**
|
|
@@ -1856,7 +2077,8 @@ export interface DescribeLocationFsxLustreResponse {
|
|
|
1856
2077
|
*/
|
|
1857
2078
|
export interface DescribeLocationFsxOntapRequest {
|
|
1858
2079
|
/**
|
|
1859
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system
|
|
2080
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system
|
|
2081
|
+
* location that you want information about.</p>
|
|
1860
2082
|
*/
|
|
1861
2083
|
LocationArn: string | undefined;
|
|
1862
2084
|
}
|
|
@@ -1878,15 +2100,18 @@ export interface DescribeLocationFsxOntapResponse {
|
|
|
1878
2100
|
*/
|
|
1879
2101
|
LocationUri?: string;
|
|
1880
2102
|
/**
|
|
1881
|
-
* <p>Specifies the data transfer protocol that DataSync uses to access your
|
|
2103
|
+
* <p>Specifies the data transfer protocol that DataSync uses to access your
|
|
2104
|
+
* Amazon FSx file system.</p>
|
|
1882
2105
|
*/
|
|
1883
2106
|
Protocol?: FsxProtocol;
|
|
1884
2107
|
/**
|
|
1885
|
-
* <p>The security groups that DataSync uses to access your FSx for ONTAP
|
|
2108
|
+
* <p>The security groups that DataSync uses to access your FSx for ONTAP
|
|
2109
|
+
* file system.</p>
|
|
1886
2110
|
*/
|
|
1887
2111
|
SecurityGroupArns?: string[];
|
|
1888
2112
|
/**
|
|
1889
|
-
* <p>The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system
|
|
2113
|
+
* <p>The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system
|
|
2114
|
+
* where you're copying data to or from.</p>
|
|
1890
2115
|
*/
|
|
1891
2116
|
StorageVirtualMachineArn?: string;
|
|
1892
2117
|
/**
|
|
@@ -1924,8 +2149,7 @@ export interface DescribeLocationFsxOpenZfsResponse {
|
|
|
1924
2149
|
*/
|
|
1925
2150
|
SecurityGroupArns?: string[];
|
|
1926
2151
|
/**
|
|
1927
|
-
* <p>The type of protocol that DataSync uses to
|
|
1928
|
-
* access your file system.</p>
|
|
2152
|
+
* <p>The type of protocol that DataSync uses to access your file system.</p>
|
|
1929
2153
|
*/
|
|
1930
2154
|
Protocol?: FsxProtocol;
|
|
1931
2155
|
/**
|
|
@@ -2085,7 +2309,8 @@ export interface DescribeLocationNfsResponse {
|
|
|
2085
2309
|
*/
|
|
2086
2310
|
export interface DescribeLocationObjectStorageRequest {
|
|
2087
2311
|
/**
|
|
2088
|
-
* <p>The Amazon Resource Name (ARN) of the object storage system location that you want
|
|
2312
|
+
* <p>The Amazon Resource Name (ARN) of the object storage system location that you want
|
|
2313
|
+
* information about.</p>
|
|
2089
2314
|
*/
|
|
2090
2315
|
LocationArn: string | undefined;
|
|
2091
2316
|
}
|
|
@@ -2108,7 +2333,8 @@ export interface DescribeLocationObjectStorageResponse {
|
|
|
2108
2333
|
*/
|
|
2109
2334
|
AccessKey?: string;
|
|
2110
2335
|
/**
|
|
2111
|
-
* <p>The port that your object storage server accepts inbound network traffic on (for example,
|
|
2336
|
+
* <p>The port that your object storage server accepts inbound network traffic on (for example,
|
|
2337
|
+
* port 443).</p>
|
|
2112
2338
|
*/
|
|
2113
2339
|
ServerPort?: number;
|
|
2114
2340
|
/**
|
|
@@ -2116,7 +2342,8 @@ export interface DescribeLocationObjectStorageResponse {
|
|
|
2116
2342
|
*/
|
|
2117
2343
|
ServerProtocol?: ObjectStorageServerProtocol | string;
|
|
2118
2344
|
/**
|
|
2119
|
-
* <p>The ARNs of the DataSync agents that can securely connect with your
|
|
2345
|
+
* <p>The ARNs of the DataSync agents that can securely connect with your
|
|
2346
|
+
* location.</p>
|
|
2120
2347
|
*/
|
|
2121
2348
|
AgentArns?: string[];
|
|
2122
2349
|
/**
|
|
@@ -2155,8 +2382,9 @@ export interface DescribeLocationS3Response {
|
|
|
2155
2382
|
/**
|
|
2156
2383
|
* <p>The Amazon S3 storage class that you chose to store your files in when this location is
|
|
2157
2384
|
* used as a task destination. For more information about S3 storage classes, see <a href="http://aws.amazon.com/s3/storage-classes/">Amazon S3 Storage Classes</a>. Some storage
|
|
2158
|
-
* classes have behaviors that can affect your S3 storage cost. For detailed information, see
|
|
2159
|
-
*
|
|
2385
|
+
* classes have behaviors that can affect your S3 storage cost. For detailed information, see
|
|
2386
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations
|
|
2387
|
+
* when working with S3 storage classes in DataSync</a>.</p>
|
|
2160
2388
|
*/
|
|
2161
2389
|
S3StorageClass?: S3StorageClass | string;
|
|
2162
2390
|
/**
|
|
@@ -2167,9 +2395,10 @@ export interface DescribeLocationS3Response {
|
|
|
2167
2395
|
*/
|
|
2168
2396
|
S3Config?: S3Config;
|
|
2169
2397
|
/**
|
|
2170
|
-
* <p>If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name
|
|
2171
|
-
* agents deployed on your Outpost. For more information about launching a
|
|
2172
|
-
* Amazon Web Services Outpost, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent">Deploy your DataSync agent
|
|
2398
|
+
* <p>If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name
|
|
2399
|
+
* (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a
|
|
2400
|
+
* DataSync agent on an Amazon Web Services Outpost, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent">Deploy your DataSync agent
|
|
2401
|
+
* on Outposts</a>.</p>
|
|
2173
2402
|
*/
|
|
2174
2403
|
AgentArns?: string[];
|
|
2175
2404
|
/**
|
|
@@ -2225,118 +2454,751 @@ export interface DescribeLocationSmbResponse {
|
|
|
2225
2454
|
}
|
|
2226
2455
|
/**
|
|
2227
2456
|
* @public
|
|
2228
|
-
* <p>DescribeTaskRequest</p>
|
|
2229
2457
|
*/
|
|
2230
|
-
export interface
|
|
2458
|
+
export interface DescribeStorageSystemRequest {
|
|
2231
2459
|
/**
|
|
2232
|
-
* <p>
|
|
2460
|
+
* <p>Specifies the Amazon Resource Name (ARN) of an on-premises storage system that you're
|
|
2461
|
+
* using with DataSync Discovery.</p>
|
|
2233
2462
|
*/
|
|
2234
|
-
|
|
2463
|
+
StorageSystemArn: string | undefined;
|
|
2235
2464
|
}
|
|
2236
2465
|
/**
|
|
2237
2466
|
* @public
|
|
2238
2467
|
* @enum
|
|
2239
2468
|
*/
|
|
2240
|
-
export declare const
|
|
2241
|
-
readonly
|
|
2242
|
-
readonly
|
|
2243
|
-
readonly
|
|
2244
|
-
readonly RUNNING: "RUNNING";
|
|
2245
|
-
readonly UNAVAILABLE: "UNAVAILABLE";
|
|
2469
|
+
export declare const StorageSystemConnectivityStatus: {
|
|
2470
|
+
readonly FAIL: "FAIL";
|
|
2471
|
+
readonly PASS: "PASS";
|
|
2472
|
+
readonly UNKNOWN: "UNKNOWN";
|
|
2246
2473
|
};
|
|
2247
2474
|
/**
|
|
2248
2475
|
* @public
|
|
2249
2476
|
*/
|
|
2250
|
-
export type
|
|
2477
|
+
export type StorageSystemConnectivityStatus = (typeof StorageSystemConnectivityStatus)[keyof typeof StorageSystemConnectivityStatus];
|
|
2251
2478
|
/**
|
|
2252
2479
|
* @public
|
|
2253
|
-
* <p>DescribeTaskResponse</p>
|
|
2254
2480
|
*/
|
|
2255
|
-
export interface
|
|
2481
|
+
export interface DescribeStorageSystemResponse {
|
|
2256
2482
|
/**
|
|
2257
|
-
* <p>The
|
|
2483
|
+
* <p>The ARN of the on-premises storage system that the discovery job looked at.</p>
|
|
2258
2484
|
*/
|
|
2259
|
-
|
|
2485
|
+
StorageSystemArn?: string;
|
|
2260
2486
|
/**
|
|
2261
|
-
* <p>The
|
|
2262
|
-
*
|
|
2263
|
-
* Task Statuses in the <i>DataSync User Guide</i>.</p>
|
|
2487
|
+
* <p>The server name and network port required to connect with your on-premises storage
|
|
2488
|
+
* system's management interface.</p>
|
|
2264
2489
|
*/
|
|
2265
|
-
|
|
2490
|
+
ServerConfiguration?: DiscoveryServerConfiguration;
|
|
2266
2491
|
/**
|
|
2267
|
-
* <p>The
|
|
2492
|
+
* <p>The type of on-premises storage system.</p>
|
|
2493
|
+
* <note>
|
|
2494
|
+
* <p>DataSync Discovery currently only supports NetApp
|
|
2495
|
+
* Fabric-Attached
|
|
2496
|
+
* Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
|
|
2497
|
+
* </p>
|
|
2498
|
+
* </note>
|
|
2268
2499
|
*/
|
|
2269
|
-
|
|
2500
|
+
SystemType?: DiscoverySystemType | string;
|
|
2270
2501
|
/**
|
|
2271
|
-
* <p>The
|
|
2502
|
+
* <p>The ARN of the DataSync agent that connects to and reads from your on-premises storage
|
|
2503
|
+
* system.</p>
|
|
2272
2504
|
*/
|
|
2273
|
-
|
|
2505
|
+
AgentArns?: string[];
|
|
2274
2506
|
/**
|
|
2275
|
-
* <p>The
|
|
2507
|
+
* <p>The name that you gave your on-premises storage system when adding it to DataSync Discovery.</p>
|
|
2276
2508
|
*/
|
|
2277
|
-
|
|
2509
|
+
Name?: string;
|
|
2278
2510
|
/**
|
|
2279
|
-
* <p>
|
|
2511
|
+
* <p>Describes the connectivity error that the DataSync agent is encountering with your
|
|
2512
|
+
* on-premises storage system.</p>
|
|
2280
2513
|
*/
|
|
2281
|
-
|
|
2514
|
+
ErrorMessage?: string;
|
|
2282
2515
|
/**
|
|
2283
|
-
* <p>
|
|
2284
|
-
|
|
2285
|
-
|
|
2286
|
-
|
|
2516
|
+
* <p>Indicates whether your DataSync agent can connect to your on-premises storage system.</p>
|
|
2517
|
+
*/
|
|
2518
|
+
ConnectivityStatus?: StorageSystemConnectivityStatus | string;
|
|
2519
|
+
/**
|
|
2520
|
+
* <p>The ARN of the Amazon CloudWatch log group that's used to monitor and log discovery
|
|
2521
|
+
* job events.</p>
|
|
2287
2522
|
*/
|
|
2288
2523
|
CloudWatchLogGroupArn?: string;
|
|
2289
2524
|
/**
|
|
2290
|
-
* <p>The
|
|
2525
|
+
* <p>The time when you added the on-premises storage system to DataSync Discovery.</p>
|
|
2291
2526
|
*/
|
|
2292
|
-
|
|
2527
|
+
CreationTime?: Date;
|
|
2293
2528
|
/**
|
|
2294
|
-
* <p>The
|
|
2529
|
+
* <p>The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery
|
|
2530
|
+
* stores these credentials in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-configure-storage.html#discovery-add-storage">Secrets Manager</a>.</p>
|
|
2295
2531
|
*/
|
|
2296
|
-
|
|
2532
|
+
SecretsManagerArn?: string;
|
|
2533
|
+
}
|
|
2534
|
+
/**
|
|
2535
|
+
* @public
|
|
2536
|
+
* @enum
|
|
2537
|
+
*/
|
|
2538
|
+
export declare const DiscoveryResourceType: {
|
|
2539
|
+
readonly CLUSTER: "CLUSTER";
|
|
2540
|
+
readonly SVM: "SVM";
|
|
2541
|
+
readonly VOLUME: "VOLUME";
|
|
2542
|
+
};
|
|
2543
|
+
/**
|
|
2544
|
+
* @public
|
|
2545
|
+
*/
|
|
2546
|
+
export type DiscoveryResourceType = (typeof DiscoveryResourceType)[keyof typeof DiscoveryResourceType];
|
|
2547
|
+
/**
|
|
2548
|
+
* @public
|
|
2549
|
+
*/
|
|
2550
|
+
export interface DescribeStorageSystemResourceMetricsRequest {
|
|
2297
2551
|
/**
|
|
2298
|
-
* <p>
|
|
2299
|
-
*
|
|
2552
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the discovery job that collects information
|
|
2553
|
+
* about your on-premises storage system.</p>
|
|
2300
2554
|
*/
|
|
2301
|
-
|
|
2555
|
+
DiscoveryJobArn: string | undefined;
|
|
2302
2556
|
/**
|
|
2303
|
-
* <p>
|
|
2557
|
+
* <p>Specifies the kind of storage system resource that you want information about.</p>
|
|
2304
2558
|
*/
|
|
2305
|
-
|
|
2559
|
+
ResourceType: DiscoveryResourceType | string | undefined;
|
|
2306
2560
|
/**
|
|
2307
|
-
* <p>
|
|
2561
|
+
* <p>Specifies the universally unique identifier (UUID) of the storage system resource that you
|
|
2562
|
+
* want information about.</p>
|
|
2308
2563
|
*/
|
|
2309
|
-
|
|
2564
|
+
ResourceId: string | undefined;
|
|
2310
2565
|
/**
|
|
2311
|
-
* <p>
|
|
2312
|
-
*
|
|
2566
|
+
* <p>Specifies a time within the total duration that the discovery job ran. To see information
|
|
2567
|
+
* gathered during a certain time frame, use this parameter with <code>EndTime</code>.</p>
|
|
2313
2568
|
*/
|
|
2314
|
-
|
|
2569
|
+
StartTime?: Date;
|
|
2315
2570
|
/**
|
|
2316
|
-
* <p>
|
|
2317
|
-
*
|
|
2571
|
+
* <p>Specifies a time within the total duration that the discovery job ran. To see information
|
|
2572
|
+
* gathered during a certain time frame, use this parameter with <code>StartTime</code>.</p>
|
|
2318
2573
|
*/
|
|
2319
|
-
|
|
2574
|
+
EndTime?: Date;
|
|
2320
2575
|
/**
|
|
2321
|
-
* <p>
|
|
2576
|
+
* <p>Specifies how many results that you want in the response.</p>
|
|
2322
2577
|
*/
|
|
2323
|
-
|
|
2578
|
+
MaxResults?: number;
|
|
2324
2579
|
/**
|
|
2325
|
-
* <p>
|
|
2580
|
+
* <p>Specifies an opaque string that indicates the position to begin the next list of results
|
|
2581
|
+
* in the response.</p>
|
|
2326
2582
|
*/
|
|
2327
|
-
|
|
2583
|
+
NextToken?: string;
|
|
2328
2584
|
}
|
|
2329
2585
|
/**
|
|
2330
2586
|
* @public
|
|
2331
|
-
* <p>
|
|
2587
|
+
* <p>The IOPS peaks for an on-premises storage system
|
|
2588
|
+
* resource.
|
|
2589
|
+
* Each data point represents the 95th percentile peak value during a 1-hour interval.</p>
|
|
2332
2590
|
*/
|
|
2333
|
-
export interface
|
|
2591
|
+
export interface IOPS {
|
|
2334
2592
|
/**
|
|
2335
|
-
* <p>
|
|
2593
|
+
* <p>Peak IOPS related to read operations.</p>
|
|
2336
2594
|
*/
|
|
2337
|
-
|
|
2338
|
-
|
|
2339
|
-
|
|
2595
|
+
Read?: number;
|
|
2596
|
+
/**
|
|
2597
|
+
* <p>Peak IOPS related to write operations.</p>
|
|
2598
|
+
*/
|
|
2599
|
+
Write?: number;
|
|
2600
|
+
/**
|
|
2601
|
+
* <p>Peak IOPS unrelated to read and write operations.</p>
|
|
2602
|
+
*/
|
|
2603
|
+
Other?: number;
|
|
2604
|
+
/**
|
|
2605
|
+
* <p>Peak total IOPS on your on-premises storage system resource.</p>
|
|
2606
|
+
*/
|
|
2607
|
+
Total?: number;
|
|
2608
|
+
}
|
|
2609
|
+
/**
|
|
2610
|
+
* @public
|
|
2611
|
+
* <p>The latency peaks for an on-premises storage system
|
|
2612
|
+
* resource.
|
|
2613
|
+
* Each data point represents the 95th percentile peak value during a 1-hour interval.</p>
|
|
2614
|
+
*/
|
|
2615
|
+
export interface Latency {
|
|
2616
|
+
/**
|
|
2617
|
+
* <p>Peak latency for read operations.</p>
|
|
2618
|
+
*/
|
|
2619
|
+
Read?: number;
|
|
2620
|
+
/**
|
|
2621
|
+
* <p>Peak latency for write operations.</p>
|
|
2622
|
+
*/
|
|
2623
|
+
Write?: number;
|
|
2624
|
+
/**
|
|
2625
|
+
* <p>Peak latency for operations unrelated to read and write operations.</p>
|
|
2626
|
+
*/
|
|
2627
|
+
Other?: number;
|
|
2628
|
+
}
|
|
2629
|
+
/**
|
|
2630
|
+
* @public
|
|
2631
|
+
* <p>The throughput peaks for an on-premises storage system volume. Each data point represents
|
|
2632
|
+
* the 95th percentile peak value during a 1-hour interval.</p>
|
|
2633
|
+
*/
|
|
2634
|
+
export interface Throughput {
|
|
2635
|
+
/**
|
|
2636
|
+
* <p>Peak throughput related to read operations.</p>
|
|
2637
|
+
*/
|
|
2638
|
+
Read?: number;
|
|
2639
|
+
/**
|
|
2640
|
+
* <p>Peak throughput related to write operations.</p>
|
|
2641
|
+
*/
|
|
2642
|
+
Write?: number;
|
|
2643
|
+
/**
|
|
2644
|
+
* <p>Peak throughput unrelated to read and write operations.</p>
|
|
2645
|
+
*/
|
|
2646
|
+
Other?: number;
|
|
2647
|
+
/**
|
|
2648
|
+
* <p>Peak total throughput on your on-premises storage system resource.</p>
|
|
2649
|
+
*/
|
|
2650
|
+
Total?: number;
|
|
2651
|
+
}
|
|
2652
|
+
/**
|
|
2653
|
+
* @public
|
|
2654
|
+
* <p>The types of performance data that DataSync Discovery collects about an on-premises storage system
|
|
2655
|
+
* resource.</p>
|
|
2656
|
+
*/
|
|
2657
|
+
export interface P95Metrics {
|
|
2658
|
+
/**
|
|
2659
|
+
* <p>The IOPS peaks for an on-premises storage system resource. Each data point represents the
|
|
2660
|
+
* 95th percentile peak value during a 1-hour interval.</p>
|
|
2661
|
+
*/
|
|
2662
|
+
IOPS?: IOPS;
|
|
2663
|
+
/**
|
|
2664
|
+
* <p>The throughput peaks for an on-premises storage system resource. Each data point
|
|
2665
|
+
* represents the 95th percentile peak value during a 1-hour interval.</p>
|
|
2666
|
+
*/
|
|
2667
|
+
Throughput?: Throughput;
|
|
2668
|
+
/**
|
|
2669
|
+
* <p>The latency peaks for an on-premises storage system resource. Each data point represents
|
|
2670
|
+
* the 95th percentile peak value during a 1-hour interval.</p>
|
|
2671
|
+
*/
|
|
2672
|
+
Latency?: Latency;
|
|
2673
|
+
}
|
|
2674
|
+
/**
|
|
2675
|
+
* @public
|
|
2676
|
+
* <p>Information, including performance data and capacity usage, provided by DataSync Discovery about a
|
|
2677
|
+
* resource in your on-premises storage system.</p>
|
|
2678
|
+
*/
|
|
2679
|
+
export interface ResourceMetrics {
|
|
2680
|
+
/**
|
|
2681
|
+
* <p>The time when DataSync Discovery collected this information from the
|
|
2682
|
+
* resource.</p>
|
|
2683
|
+
*/
|
|
2684
|
+
Timestamp?: Date;
|
|
2685
|
+
/**
|
|
2686
|
+
* <p>The types of performance data that DataSync Discovery collects about the on-premises storage system
|
|
2687
|
+
* resource.</p>
|
|
2688
|
+
*/
|
|
2689
|
+
P95Metrics?: P95Metrics;
|
|
2690
|
+
/**
|
|
2691
|
+
* <p>The storage capacity of the on-premises storage system resource.</p>
|
|
2692
|
+
*/
|
|
2693
|
+
Capacity?: Capacity;
|
|
2694
|
+
/**
|
|
2695
|
+
* <p>The universally unique identifier (UUID) of the on-premises storage system
|
|
2696
|
+
* resource.</p>
|
|
2697
|
+
*/
|
|
2698
|
+
ResourceId?: string;
|
|
2699
|
+
/**
|
|
2700
|
+
* <p>The type of on-premises storage system resource.</p>
|
|
2701
|
+
*/
|
|
2702
|
+
ResourceType?: DiscoveryResourceType | string;
|
|
2703
|
+
}
|
|
2704
|
+
/**
|
|
2705
|
+
* @public
|
|
2706
|
+
*/
|
|
2707
|
+
export interface DescribeStorageSystemResourceMetricsResponse {
|
|
2708
|
+
/**
|
|
2709
|
+
* <p>The details that your discovery job collected about your storage system resource.</p>
|
|
2710
|
+
*/
|
|
2711
|
+
Metrics?: ResourceMetrics[];
|
|
2712
|
+
/**
|
|
2713
|
+
* <p>The opaque string that indicates the position to begin the next list of results in the
|
|
2714
|
+
* response.</p>
|
|
2715
|
+
*/
|
|
2716
|
+
NextToken?: string;
|
|
2717
|
+
}
|
|
2718
|
+
/**
|
|
2719
|
+
* @public
|
|
2720
|
+
* @enum
|
|
2721
|
+
*/
|
|
2722
|
+
export declare const DiscoveryResourceFilter: {
|
|
2723
|
+
readonly SVM: "SVM";
|
|
2724
|
+
};
|
|
2725
|
+
/**
|
|
2726
|
+
* @public
|
|
2727
|
+
*/
|
|
2728
|
+
export type DiscoveryResourceFilter = (typeof DiscoveryResourceFilter)[keyof typeof DiscoveryResourceFilter];
|
|
2729
|
+
/**
|
|
2730
|
+
* @public
|
|
2731
|
+
*/
|
|
2732
|
+
export interface DescribeStorageSystemResourcesRequest {
|
|
2733
|
+
/**
|
|
2734
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from
|
|
2735
|
+
* your on-premises storage system.</p>
|
|
2736
|
+
*/
|
|
2737
|
+
DiscoveryJobArn: string | undefined;
|
|
2738
|
+
/**
|
|
2739
|
+
* <p>Specifies what kind of storage system resources that you want information about.</p>
|
|
2740
|
+
*/
|
|
2741
|
+
ResourceType: DiscoveryResourceType | string | undefined;
|
|
2742
|
+
/**
|
|
2743
|
+
* <p>Specifies the universally unique identifiers (UUIDs) of the storage system resources that
|
|
2744
|
+
* you want information about. You can't use this parameter in combination with the
|
|
2745
|
+
* <code>Filter</code> parameter.</p>
|
|
2746
|
+
*/
|
|
2747
|
+
ResourceIds?: string[];
|
|
2748
|
+
/**
|
|
2749
|
+
* <p>Filters the storage system resources that you want returned. For example, this might be
|
|
2750
|
+
* volumes associated with a specific storage virtual machine (SVM).</p>
|
|
2751
|
+
*/
|
|
2752
|
+
Filter?: Record<string, string[]>;
|
|
2753
|
+
/**
|
|
2754
|
+
* <p>Specifies the maximum number of storage system resources that you want to list in a
|
|
2755
|
+
* response.</p>
|
|
2756
|
+
*/
|
|
2757
|
+
MaxResults?: number;
|
|
2758
|
+
/**
|
|
2759
|
+
* <p>Specifies an opaque string that indicates the position to begin the next list of results
|
|
2760
|
+
* in the response.</p>
|
|
2761
|
+
*/
|
|
2762
|
+
NextToken?: string;
|
|
2763
|
+
}
|
|
2764
|
+
/**
|
|
2765
|
+
* @public
|
|
2766
|
+
* <p>The performance data that DataSync Discovery collects about an on-premises storage system
|
|
2767
|
+
* resource.</p>
|
|
2768
|
+
*/
|
|
2769
|
+
export interface MaxP95Performance {
|
|
2770
|
+
/**
|
|
2771
|
+
* <p>Peak IOPS related to read operations.</p>
|
|
2772
|
+
*/
|
|
2773
|
+
IopsRead?: number;
|
|
2774
|
+
/**
|
|
2775
|
+
* <p>Peak IOPS related to write operations.</p>
|
|
2776
|
+
*/
|
|
2777
|
+
IopsWrite?: number;
|
|
2778
|
+
/**
|
|
2779
|
+
* <p>Peak IOPS unrelated to read and write operations.</p>
|
|
2780
|
+
*/
|
|
2781
|
+
IopsOther?: number;
|
|
2782
|
+
/**
|
|
2783
|
+
* <p>Peak total IOPS on your on-premises storage system resource.</p>
|
|
2784
|
+
*/
|
|
2785
|
+
IopsTotal?: number;
|
|
2786
|
+
/**
|
|
2787
|
+
* <p>Peak throughput related to read operations.</p>
|
|
2788
|
+
*/
|
|
2789
|
+
ThroughputRead?: number;
|
|
2790
|
+
/**
|
|
2791
|
+
* <p>Peak throughput related to write operations.</p>
|
|
2792
|
+
*/
|
|
2793
|
+
ThroughputWrite?: number;
|
|
2794
|
+
/**
|
|
2795
|
+
* <p>Peak throughput unrelated to read and write operations.</p>
|
|
2796
|
+
*/
|
|
2797
|
+
ThroughputOther?: number;
|
|
2798
|
+
/**
|
|
2799
|
+
* <p>Peak total throughput on your on-premises storage system resource.</p>
|
|
2800
|
+
*/
|
|
2801
|
+
ThroughputTotal?: number;
|
|
2802
|
+
/**
|
|
2803
|
+
* <p>Peak latency for read operations.</p>
|
|
2804
|
+
*/
|
|
2805
|
+
LatencyRead?: number;
|
|
2806
|
+
/**
|
|
2807
|
+
* <p>Peak latency for write operations.</p>
|
|
2808
|
+
*/
|
|
2809
|
+
LatencyWrite?: number;
|
|
2810
|
+
/**
|
|
2811
|
+
* <p>Peak latency for operations unrelated to read and write operations.</p>
|
|
2812
|
+
*/
|
|
2813
|
+
LatencyOther?: number;
|
|
2814
|
+
}
|
|
2815
|
+
/**
|
|
2816
|
+
* @public
|
|
2817
|
+
* <p>The details about an Amazon Web Services storage service that DataSync Discovery recommends for a
|
|
2818
|
+
* resource in your on-premises storage system.</p>
|
|
2819
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">Recommendations
|
|
2820
|
+
* provided by DataSync Discovery</a>.</p>
|
|
2821
|
+
*/
|
|
2822
|
+
export interface Recommendation {
|
|
2823
|
+
/**
|
|
2824
|
+
* <p>A recommended Amazon Web Services storage service that you can migrate data to based on
|
|
2825
|
+
* information that DataSync Discovery collects about your on-premises storage system.</p>
|
|
2826
|
+
*/
|
|
2827
|
+
StorageType?: string;
|
|
2828
|
+
/**
|
|
2829
|
+
* <p>Information about how you can set up a recommended Amazon Web Services storage
|
|
2830
|
+
* service.</p>
|
|
2831
|
+
*/
|
|
2832
|
+
StorageConfiguration?: Record<string, string>;
|
|
2833
|
+
/**
|
|
2834
|
+
* <p>The estimated monthly cost of the recommended Amazon Web Services storage service.</p>
|
|
2835
|
+
*/
|
|
2836
|
+
EstimatedMonthlyStorageCost?: string;
|
|
2837
|
+
}
|
|
2838
|
+
/**
|
|
2839
|
+
* @public
|
|
2840
|
+
* @enum
|
|
2841
|
+
*/
|
|
2842
|
+
export declare const RecommendationStatus: {
|
|
2843
|
+
readonly COMPLETED: "COMPLETED";
|
|
2844
|
+
readonly FAILED: "FAILED";
|
|
2845
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
2846
|
+
readonly NONE: "NONE";
|
|
2847
|
+
};
|
|
2848
|
+
/**
|
|
2849
|
+
* @public
|
|
2850
|
+
*/
|
|
2851
|
+
export type RecommendationStatus = (typeof RecommendationStatus)[keyof typeof RecommendationStatus];
|
|
2852
|
+
/**
|
|
2853
|
+
* @public
|
|
2854
|
+
* <p>The information that DataSync Discovery collects about an on-premises storage system
|
|
2855
|
+
* cluster.</p>
|
|
2856
|
+
*/
|
|
2857
|
+
export interface NetAppONTAPCluster {
|
|
2858
|
+
/**
|
|
2859
|
+
* <p>The number of CIFS shares in the cluster.</p>
|
|
2860
|
+
*/
|
|
2861
|
+
CifsShareCount?: number;
|
|
2862
|
+
/**
|
|
2863
|
+
* <p>The number of NFS volumes in the cluster.</p>
|
|
2864
|
+
*/
|
|
2865
|
+
NfsExportedVolumes?: number;
|
|
2866
|
+
/**
|
|
2867
|
+
* <p>The universally unique identifier (UUID) of the cluster.</p>
|
|
2868
|
+
*/
|
|
2869
|
+
ResourceId?: string;
|
|
2870
|
+
/**
|
|
2871
|
+
* <p>The name of the cluster.</p>
|
|
2872
|
+
*/
|
|
2873
|
+
ClusterName?: string;
|
|
2874
|
+
/**
|
|
2875
|
+
* <p>The performance data that DataSync Discovery collects about the cluster.</p>
|
|
2876
|
+
*/
|
|
2877
|
+
MaxP95Performance?: MaxP95Performance;
|
|
2878
|
+
/**
|
|
2879
|
+
* <p>The total storage space that's available in the cluster.</p>
|
|
2880
|
+
*/
|
|
2881
|
+
ClusterBlockStorageSize?: number;
|
|
2882
|
+
/**
|
|
2883
|
+
* <p>The storage space that's being used in a cluster.</p>
|
|
2884
|
+
*/
|
|
2885
|
+
ClusterBlockStorageUsed?: number;
|
|
2886
|
+
/**
|
|
2887
|
+
* <p>The storage space that's being used in the cluster without accounting for compression or
|
|
2888
|
+
* deduplication.</p>
|
|
2889
|
+
*/
|
|
2890
|
+
ClusterBlockStorageLogicalUsed?: number;
|
|
2891
|
+
/**
|
|
2892
|
+
* <p>The Amazon Web Services storage services that DataSync Discovery recommends for the cluster. For
|
|
2893
|
+
* more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">Recommendations
|
|
2894
|
+
* provided by DataSync Discovery</a>.</p>
|
|
2895
|
+
*/
|
|
2896
|
+
Recommendations?: Recommendation[];
|
|
2897
|
+
/**
|
|
2898
|
+
* <p>Indicates whether DataSync Discovery recommendations for the cluster are ready to view, incomplete,
|
|
2899
|
+
* or can't be determined.</p>
|
|
2900
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table">Recommendation statuses</a>.</p>
|
|
2901
|
+
*/
|
|
2902
|
+
RecommendationStatus?: RecommendationStatus | string;
|
|
2903
|
+
}
|
|
2904
|
+
/**
|
|
2905
|
+
* @public
|
|
2906
|
+
* <p>The information that DataSync Discovery collects about a storage virtual machine (SVM) in your
|
|
2907
|
+
* on-premises storage system.</p>
|
|
2908
|
+
*/
|
|
2909
|
+
export interface NetAppONTAPSVM {
|
|
2910
|
+
/**
|
|
2911
|
+
* <p>The universally unique identifier (UUID) of the cluster associated with the SVM.</p>
|
|
2912
|
+
*/
|
|
2913
|
+
ClusterUuid?: string;
|
|
2914
|
+
/**
|
|
2915
|
+
* <p>The UUID of the SVM.</p>
|
|
2916
|
+
*/
|
|
2917
|
+
ResourceId?: string;
|
|
2918
|
+
/**
|
|
2919
|
+
* <p>The name of the SVM</p>
|
|
2920
|
+
*/
|
|
2921
|
+
SvmName?: string;
|
|
2922
|
+
/**
|
|
2923
|
+
* <p>The number of CIFS shares in the SVM.</p>
|
|
2924
|
+
*/
|
|
2925
|
+
CifsShareCount?: number;
|
|
2926
|
+
/**
|
|
2927
|
+
* <p>The data transfer protocols (such as NFS) configured for the SVM.</p>
|
|
2928
|
+
*/
|
|
2929
|
+
EnabledProtocols?: string[];
|
|
2930
|
+
/**
|
|
2931
|
+
* <p>The storage space that's being used in the SVM.</p>
|
|
2932
|
+
*/
|
|
2933
|
+
TotalCapacityUsed?: number;
|
|
2934
|
+
/**
|
|
2935
|
+
* <p>The total storage space that's available in the SVM.</p>
|
|
2936
|
+
*/
|
|
2937
|
+
TotalCapacityProvisioned?: number;
|
|
2938
|
+
/**
|
|
2939
|
+
* <p>The storage space that's being used in the SVM without accounting for compression or
|
|
2940
|
+
* deduplication.</p>
|
|
2941
|
+
*/
|
|
2942
|
+
TotalLogicalCapacityUsed?: number;
|
|
2943
|
+
/**
|
|
2944
|
+
* <p>The performance data that DataSync Discovery collects about the SVM.</p>
|
|
2945
|
+
*/
|
|
2946
|
+
MaxP95Performance?: MaxP95Performance;
|
|
2947
|
+
/**
|
|
2948
|
+
* <p>The Amazon Web Services storage services that DataSync Discovery recommends for the SVM. For more
|
|
2949
|
+
* information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">Recommendations
|
|
2950
|
+
* provided by DataSync Discovery</a>.</p>
|
|
2951
|
+
*/
|
|
2952
|
+
Recommendations?: Recommendation[];
|
|
2953
|
+
/**
|
|
2954
|
+
* <p>The number of NFS volumes in the SVM.</p>
|
|
2955
|
+
*/
|
|
2956
|
+
NfsExportedVolumes?: number;
|
|
2957
|
+
/**
|
|
2958
|
+
* <p>Indicates whether DataSync Discovery recommendations for the SVM are ready to view, incomplete, or
|
|
2959
|
+
* can't be determined.</p>
|
|
2960
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table">Recommendation statuses</a>.</p>
|
|
2961
|
+
*/
|
|
2962
|
+
RecommendationStatus?: RecommendationStatus | string;
|
|
2963
|
+
/**
|
|
2964
|
+
* <p>The amount of storage in the SVM that's being used for snapshots.</p>
|
|
2965
|
+
*/
|
|
2966
|
+
TotalSnapshotCapacityUsed?: number;
|
|
2967
|
+
}
|
|
2968
|
+
/**
|
|
2969
|
+
* @public
|
|
2970
|
+
* <p>The information that DataSync Discovery collects about a volume in your on-premises storage
|
|
2971
|
+
* system.</p>
|
|
2972
|
+
*/
|
|
2973
|
+
export interface NetAppONTAPVolume {
|
|
2974
|
+
/**
|
|
2975
|
+
* <p>The name of the volume.</p>
|
|
2976
|
+
*/
|
|
2977
|
+
VolumeName?: string;
|
|
2978
|
+
/**
|
|
2979
|
+
* <p>The universally unique identifier (UUID) of the volume.</p>
|
|
2980
|
+
*/
|
|
2981
|
+
ResourceId?: string;
|
|
2982
|
+
/**
|
|
2983
|
+
* <p>The number of CIFS shares in the volume.</p>
|
|
2984
|
+
*/
|
|
2985
|
+
CifsShareCount?: number;
|
|
2986
|
+
/**
|
|
2987
|
+
* <p>The volume's security style (such as Unix or NTFS).</p>
|
|
2988
|
+
*/
|
|
2989
|
+
SecurityStyle?: string;
|
|
2990
|
+
/**
|
|
2991
|
+
* <p>The UUID of the storage virtual machine (SVM) associated with the volume.</p>
|
|
2992
|
+
*/
|
|
2993
|
+
SvmUuid?: string;
|
|
2994
|
+
/**
|
|
2995
|
+
* <p>The name of the SVM associated with the volume.</p>
|
|
2996
|
+
*/
|
|
2997
|
+
SvmName?: string;
|
|
2998
|
+
/**
|
|
2999
|
+
* <p>The storage space that's being used in the volume.</p>
|
|
3000
|
+
*/
|
|
3001
|
+
CapacityUsed?: number;
|
|
3002
|
+
/**
|
|
3003
|
+
* <p>The total storage space that's available in the volume.</p>
|
|
3004
|
+
*/
|
|
3005
|
+
CapacityProvisioned?: number;
|
|
3006
|
+
/**
|
|
3007
|
+
* <p>The storage space that's being used in the volume without accounting for compression or
|
|
3008
|
+
* deduplication.</p>
|
|
3009
|
+
*/
|
|
3010
|
+
LogicalCapacityUsed?: number;
|
|
3011
|
+
/**
|
|
3012
|
+
* <p>The number of NFS volumes in the volume.</p>
|
|
3013
|
+
*/
|
|
3014
|
+
NfsExported?: boolean;
|
|
3015
|
+
/**
|
|
3016
|
+
* <p>The amount of storage in the volume that's being used for snapshots.</p>
|
|
3017
|
+
*/
|
|
3018
|
+
SnapshotCapacityUsed?: number;
|
|
3019
|
+
/**
|
|
3020
|
+
* <p>The performance data that DataSync Discovery collects about the volume.</p>
|
|
3021
|
+
*/
|
|
3022
|
+
MaxP95Performance?: MaxP95Performance;
|
|
3023
|
+
/**
|
|
3024
|
+
* <p>The Amazon Web Services storage services that DataSync Discovery recommends for the volume. For more
|
|
3025
|
+
* information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">Recommendations
|
|
3026
|
+
* provided by DataSync Discovery</a>.</p>
|
|
3027
|
+
*/
|
|
3028
|
+
Recommendations?: Recommendation[];
|
|
3029
|
+
/**
|
|
3030
|
+
* <p>Indicates whether DataSync Discovery recommendations for the volume are ready to view, incomplete,
|
|
3031
|
+
* or can't be determined.</p>
|
|
3032
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table">Recommendation statuses</a>.</p>
|
|
3033
|
+
*/
|
|
3034
|
+
RecommendationStatus?: RecommendationStatus | string;
|
|
3035
|
+
}
|
|
3036
|
+
/**
|
|
3037
|
+
* @public
|
|
3038
|
+
* <p>Information provided by DataSync Discovery about the resources in your on-premises storage
|
|
3039
|
+
* system.</p>
|
|
3040
|
+
*/
|
|
3041
|
+
export interface ResourceDetails {
|
|
3042
|
+
/**
|
|
3043
|
+
* <p>The information that DataSync Discovery collects about storage virtual machines (SVMs) in your
|
|
3044
|
+
* on-premises storage system.</p>
|
|
3045
|
+
*/
|
|
3046
|
+
NetAppONTAPSVMs?: NetAppONTAPSVM[];
|
|
3047
|
+
/**
|
|
3048
|
+
* <p>The information that DataSync Discovery collects about volumes in your on-premises storage
|
|
3049
|
+
* system.</p>
|
|
3050
|
+
*/
|
|
3051
|
+
NetAppONTAPVolumes?: NetAppONTAPVolume[];
|
|
3052
|
+
/**
|
|
3053
|
+
* <p>The information that DataSync Discovery collects about the
|
|
3054
|
+
* cluster
|
|
3055
|
+
* in your on-premises storage system.</p>
|
|
3056
|
+
*/
|
|
3057
|
+
NetAppONTAPClusters?: NetAppONTAPCluster[];
|
|
3058
|
+
}
|
|
3059
|
+
/**
|
|
3060
|
+
* @public
|
|
3061
|
+
*/
|
|
3062
|
+
export interface DescribeStorageSystemResourcesResponse {
|
|
3063
|
+
/**
|
|
3064
|
+
* <p>The information collected about your storage system's resources. A response can also
|
|
3065
|
+
* include Amazon Web Services storage service recommendations.</p>
|
|
3066
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-findings.html">storage resource
|
|
3067
|
+
* information</a> collected by and <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">recommendations</a> provided by DataSync Discovery.</p>
|
|
3068
|
+
*/
|
|
3069
|
+
ResourceDetails?: ResourceDetails;
|
|
3070
|
+
/**
|
|
3071
|
+
* <p>The opaque string that indicates the position to begin the next list of results in the
|
|
3072
|
+
* response.</p>
|
|
3073
|
+
*/
|
|
3074
|
+
NextToken?: string;
|
|
3075
|
+
}
|
|
3076
|
+
/**
|
|
3077
|
+
* @public
|
|
3078
|
+
* <p>DescribeTaskRequest</p>
|
|
3079
|
+
*/
|
|
3080
|
+
export interface DescribeTaskRequest {
|
|
3081
|
+
/**
|
|
3082
|
+
* <p>The Amazon Resource Name (ARN) of the task to describe.</p>
|
|
3083
|
+
*/
|
|
3084
|
+
TaskArn: string | undefined;
|
|
3085
|
+
}
|
|
3086
|
+
/**
|
|
3087
|
+
* @public
|
|
3088
|
+
* @enum
|
|
3089
|
+
*/
|
|
3090
|
+
export declare const TaskStatus: {
|
|
3091
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
3092
|
+
readonly CREATING: "CREATING";
|
|
3093
|
+
readonly QUEUED: "QUEUED";
|
|
3094
|
+
readonly RUNNING: "RUNNING";
|
|
3095
|
+
readonly UNAVAILABLE: "UNAVAILABLE";
|
|
3096
|
+
};
|
|
3097
|
+
/**
|
|
3098
|
+
* @public
|
|
3099
|
+
*/
|
|
3100
|
+
export type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus];
|
|
3101
|
+
/**
|
|
3102
|
+
* @public
|
|
3103
|
+
* <p>DescribeTaskResponse</p>
|
|
3104
|
+
*/
|
|
3105
|
+
export interface DescribeTaskResponse {
|
|
3106
|
+
/**
|
|
3107
|
+
* <p>The Amazon Resource Name (ARN) of the task that was described.</p>
|
|
3108
|
+
*/
|
|
3109
|
+
TaskArn?: string;
|
|
3110
|
+
/**
|
|
3111
|
+
* <p>The status of the task that was described.</p>
|
|
3112
|
+
* <p>For detailed information about task execution statuses, see Understanding
|
|
3113
|
+
* Task Statuses in the <i>DataSync User Guide</i>.</p>
|
|
3114
|
+
*/
|
|
3115
|
+
Status?: TaskStatus | string;
|
|
3116
|
+
/**
|
|
3117
|
+
* <p>The name of the task that was described.</p>
|
|
3118
|
+
*/
|
|
3119
|
+
Name?: string;
|
|
3120
|
+
/**
|
|
3121
|
+
* <p>The Amazon Resource Name (ARN) of the task execution that is transferring
|
|
3122
|
+
* files.</p>
|
|
3123
|
+
*/
|
|
3124
|
+
CurrentTaskExecutionArn?: string;
|
|
3125
|
+
/**
|
|
3126
|
+
* <p>The Amazon Resource Name (ARN) of the source file system's location.</p>
|
|
3127
|
+
*/
|
|
3128
|
+
SourceLocationArn?: string;
|
|
3129
|
+
/**
|
|
3130
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's
|
|
3131
|
+
* location.</p>
|
|
3132
|
+
*/
|
|
3133
|
+
DestinationLocationArn?: string;
|
|
3134
|
+
/**
|
|
3135
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to
|
|
3136
|
+
* monitor and log events in the task.</p>
|
|
3137
|
+
* <p>For more information on these groups, see Working with Log Groups and Log
|
|
3138
|
+
* Streams in the <i>Amazon CloudWatch User Guide</i>.</p>
|
|
3139
|
+
*/
|
|
3140
|
+
CloudWatchLogGroupArn?: string;
|
|
3141
|
+
/**
|
|
3142
|
+
* <p>The Amazon Resource Names (ARNs) of the network interfaces created for your source
|
|
3143
|
+
* location. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">Network
|
|
3144
|
+
* interface requirements</a>.</p>
|
|
3145
|
+
*/
|
|
3146
|
+
SourceNetworkInterfaceArns?: string[];
|
|
3147
|
+
/**
|
|
3148
|
+
* <p>The Amazon Resource Names (ARNs) of the network interfaces created for your destination
|
|
3149
|
+
* location. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">Network
|
|
3150
|
+
* interface requirements</a>.</p>
|
|
3151
|
+
*/
|
|
3152
|
+
DestinationNetworkInterfaceArns?: string[];
|
|
3153
|
+
/**
|
|
3154
|
+
* <p>The configuration options that control the behavior of the
|
|
3155
|
+
* <code>StartTaskExecution</code> operation. Some options include preserving file or object
|
|
3156
|
+
* metadata and verifying data integrity.</p>
|
|
3157
|
+
* <p>You can override these options for each task execution. For more information, see
|
|
3158
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
|
|
3159
|
+
*/
|
|
3160
|
+
Options?: Options;
|
|
3161
|
+
/**
|
|
3162
|
+
* <p>A list of filter rules that exclude specific data during your transfer. For more
|
|
3163
|
+
* information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
3164
|
+
*/
|
|
3165
|
+
Excludes?: FilterRule[];
|
|
3166
|
+
/**
|
|
3167
|
+
* <p>The schedule used to periodically transfer files from a source to a destination
|
|
3168
|
+
* location.</p>
|
|
3169
|
+
*/
|
|
3170
|
+
Schedule?: TaskSchedule;
|
|
3171
|
+
/**
|
|
3172
|
+
* <p>Errors that DataSync encountered during execution of the task. You can
|
|
3173
|
+
* use this error code to help troubleshoot issues.</p>
|
|
3174
|
+
*/
|
|
3175
|
+
ErrorCode?: string;
|
|
3176
|
+
/**
|
|
3177
|
+
* <p>Detailed description of an error that was encountered during the task execution. You
|
|
3178
|
+
* can use this information to help troubleshoot issues. </p>
|
|
3179
|
+
*/
|
|
3180
|
+
ErrorDetail?: string;
|
|
3181
|
+
/**
|
|
3182
|
+
* <p>The time that the task was created.</p>
|
|
3183
|
+
*/
|
|
3184
|
+
CreationTime?: Date;
|
|
3185
|
+
/**
|
|
3186
|
+
* <p>A list of filter rules that include specific data during your transfer. For more
|
|
3187
|
+
* information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
3188
|
+
*/
|
|
3189
|
+
Includes?: FilterRule[];
|
|
3190
|
+
}
|
|
3191
|
+
/**
|
|
3192
|
+
* @public
|
|
3193
|
+
* <p>DescribeTaskExecutionRequest</p>
|
|
3194
|
+
*/
|
|
3195
|
+
export interface DescribeTaskExecutionRequest {
|
|
3196
|
+
/**
|
|
3197
|
+
* <p>The Amazon Resource Name (ARN) of the task that is being executed.</p>
|
|
3198
|
+
*/
|
|
3199
|
+
TaskExecutionArn: string | undefined;
|
|
3200
|
+
}
|
|
3201
|
+
/**
|
|
2340
3202
|
* @public
|
|
2341
3203
|
* @enum
|
|
2342
3204
|
*/
|
|
@@ -2357,8 +3219,8 @@ export type PhaseStatus = (typeof PhaseStatus)[keyof typeof PhaseStatus];
|
|
|
2357
3219
|
*/
|
|
2358
3220
|
export interface TaskExecutionResultDetail {
|
|
2359
3221
|
/**
|
|
2360
|
-
* <p>The total time in milliseconds that DataSync spent in the PREPARING
|
|
2361
|
-
*
|
|
3222
|
+
* <p>The total time in milliseconds that DataSync spent in the PREPARING
|
|
3223
|
+
* phase. </p>
|
|
2362
3224
|
*/
|
|
2363
3225
|
PrepareDuration?: number;
|
|
2364
3226
|
/**
|
|
@@ -2366,7 +3228,8 @@ export interface TaskExecutionResultDetail {
|
|
|
2366
3228
|
*/
|
|
2367
3229
|
PrepareStatus?: PhaseStatus | string;
|
|
2368
3230
|
/**
|
|
2369
|
-
* <p>The total time in milliseconds that DataSync took to transfer the file from
|
|
3231
|
+
* <p>The total time in milliseconds that DataSync took to transfer the file from
|
|
3232
|
+
* the source to the destination location.</p>
|
|
2370
3233
|
*/
|
|
2371
3234
|
TotalDuration?: number;
|
|
2372
3235
|
/**
|
|
@@ -2388,8 +3251,8 @@ export interface TaskExecutionResultDetail {
|
|
|
2388
3251
|
*/
|
|
2389
3252
|
VerifyStatus?: PhaseStatus | string;
|
|
2390
3253
|
/**
|
|
2391
|
-
* <p>Errors that DataSync encountered during execution of the task. You can
|
|
2392
|
-
* error code to help troubleshoot issues.</p>
|
|
3254
|
+
* <p>Errors that DataSync encountered during execution of the task. You can
|
|
3255
|
+
* use this error code to help troubleshoot issues.</p>
|
|
2393
3256
|
*/
|
|
2394
3257
|
ErrorCode?: string;
|
|
2395
3258
|
/**
|
|
@@ -2446,11 +3309,13 @@ export interface DescribeTaskExecutionResponse {
|
|
|
2446
3309
|
*/
|
|
2447
3310
|
Options?: Options;
|
|
2448
3311
|
/**
|
|
2449
|
-
* <p>A list of filter rules that exclude specific data during your transfer. For more
|
|
3312
|
+
* <p>A list of filter rules that exclude specific data during your transfer. For more
|
|
3313
|
+
* information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
2450
3314
|
*/
|
|
2451
3315
|
Excludes?: FilterRule[];
|
|
2452
3316
|
/**
|
|
2453
|
-
* <p>A list of filter rules that include specific data during your transfer. For more
|
|
3317
|
+
* <p>A list of filter rules that include specific data during your transfer. For more
|
|
3318
|
+
* information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
2454
3319
|
*/
|
|
2455
3320
|
Includes?: FilterRule[];
|
|
2456
3321
|
/**
|
|
@@ -2483,7 +3348,8 @@ export interface DescribeTaskExecutionResponse {
|
|
|
2483
3348
|
*/
|
|
2484
3349
|
FilesTransferred?: number;
|
|
2485
3350
|
/**
|
|
2486
|
-
* <p>The number of logical bytes written to the destination Amazon Web Services storage
|
|
3351
|
+
* <p>The number of logical bytes written to the destination Amazon Web Services storage
|
|
3352
|
+
* resource.</p>
|
|
2487
3353
|
*/
|
|
2488
3354
|
BytesWritten?: number;
|
|
2489
3355
|
/**
|
|
@@ -2502,6 +3368,45 @@ export interface DescribeTaskExecutionResponse {
|
|
|
2502
3368
|
*/
|
|
2503
3369
|
BytesCompressed?: number;
|
|
2504
3370
|
}
|
|
3371
|
+
/**
|
|
3372
|
+
* @public
|
|
3373
|
+
* <p>The details about a specific DataSync discovery job.</p>
|
|
3374
|
+
*/
|
|
3375
|
+
export interface DiscoveryJobListEntry {
|
|
3376
|
+
/**
|
|
3377
|
+
* <p>The Amazon Resource Name (ARN) of a discovery job.</p>
|
|
3378
|
+
*/
|
|
3379
|
+
DiscoveryJobArn?: string;
|
|
3380
|
+
/**
|
|
3381
|
+
* <p>The status of a discovery job. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table">Discovery job statuses</a>.</p>
|
|
3382
|
+
*/
|
|
3383
|
+
Status?: DiscoveryJobStatus | string;
|
|
3384
|
+
}
|
|
3385
|
+
/**
|
|
3386
|
+
* @public
|
|
3387
|
+
*/
|
|
3388
|
+
export interface GenerateRecommendationsRequest {
|
|
3389
|
+
/**
|
|
3390
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the discovery job that collects information
|
|
3391
|
+
* about your on-premises storage system.</p>
|
|
3392
|
+
*/
|
|
3393
|
+
DiscoveryJobArn: string | undefined;
|
|
3394
|
+
/**
|
|
3395
|
+
* <p>Specifies the universally unique identifiers (UUIDs) of the resources in your storage
|
|
3396
|
+
* system that you want recommendations on.</p>
|
|
3397
|
+
*/
|
|
3398
|
+
ResourceIds: string[] | undefined;
|
|
3399
|
+
/**
|
|
3400
|
+
* <p>Specifies the type of resource in your storage system that you want recommendations
|
|
3401
|
+
* on.</p>
|
|
3402
|
+
*/
|
|
3403
|
+
ResourceType: DiscoveryResourceType | string | undefined;
|
|
3404
|
+
}
|
|
3405
|
+
/**
|
|
3406
|
+
* @public
|
|
3407
|
+
*/
|
|
3408
|
+
export interface GenerateRecommendationsResponse {
|
|
3409
|
+
}
|
|
2505
3410
|
/**
|
|
2506
3411
|
* @public
|
|
2507
3412
|
* <p>ListAgentsRequest</p>
|
|
@@ -2534,6 +3439,40 @@ export interface ListAgentsResponse {
|
|
|
2534
3439
|
*/
|
|
2535
3440
|
NextToken?: string;
|
|
2536
3441
|
}
|
|
3442
|
+
/**
|
|
3443
|
+
* @public
|
|
3444
|
+
*/
|
|
3445
|
+
export interface ListDiscoveryJobsRequest {
|
|
3446
|
+
/**
|
|
3447
|
+
* <p>Specifies the Amazon Resource Name (ARN) of an on-premises storage system. Use this
|
|
3448
|
+
* parameter if you only want to list the discovery jobs that are associated with a specific
|
|
3449
|
+
* storage system.</p>
|
|
3450
|
+
*/
|
|
3451
|
+
StorageSystemArn?: string;
|
|
3452
|
+
/**
|
|
3453
|
+
* <p>Specifies how many results you want in the response.</p>
|
|
3454
|
+
*/
|
|
3455
|
+
MaxResults?: number;
|
|
3456
|
+
/**
|
|
3457
|
+
* <p>Specifies an opaque string that indicates the position to begin the next list of results
|
|
3458
|
+
* in the response.</p>
|
|
3459
|
+
*/
|
|
3460
|
+
NextToken?: string;
|
|
3461
|
+
}
|
|
3462
|
+
/**
|
|
3463
|
+
* @public
|
|
3464
|
+
*/
|
|
3465
|
+
export interface ListDiscoveryJobsResponse {
|
|
3466
|
+
/**
|
|
3467
|
+
* <p>The discovery jobs that you've run.</p>
|
|
3468
|
+
*/
|
|
3469
|
+
DiscoveryJobs?: DiscoveryJobListEntry[];
|
|
3470
|
+
/**
|
|
3471
|
+
* <p>The opaque string that indicates the position to begin the next list of results in the
|
|
3472
|
+
* response.</p>
|
|
3473
|
+
*/
|
|
3474
|
+
NextToken?: string;
|
|
3475
|
+
}
|
|
2537
3476
|
/**
|
|
2538
3477
|
* @public
|
|
2539
3478
|
* @enum
|
|
@@ -2573,23 +3512,23 @@ export type Operator = (typeof Operator)[keyof typeof Operator];
|
|
|
2573
3512
|
* see all your Amazon S3 locations, create a filter using <code>"Name":
|
|
2574
3513
|
* "LocationType"</code>, <code>"Operator": "Equals"</code>, and <code>"Values":
|
|
2575
3514
|
* "S3"</code>.</p>
|
|
2576
|
-
* <p>For more information, see
|
|
2577
|
-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html">filtering resources</a>.</p>
|
|
3515
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html">filtering resources</a>.</p>
|
|
2578
3516
|
*/
|
|
2579
3517
|
export interface LocationFilter {
|
|
2580
3518
|
/**
|
|
2581
|
-
* <p>The name of the filter being used. Each API call supports a list of filters that are
|
|
2582
|
-
* for it (for example, <code>LocationType</code> for
|
|
3519
|
+
* <p>The name of the filter being used. Each API call supports a list of filters that are
|
|
3520
|
+
* available for it (for example, <code>LocationType</code> for
|
|
3521
|
+
* <code>ListLocations</code>).</p>
|
|
2583
3522
|
*/
|
|
2584
3523
|
Name: LocationFilterName | string | undefined;
|
|
2585
3524
|
/**
|
|
2586
|
-
* <p>The values that you want to filter for. For example, you might want to display only Amazon
|
|
2587
|
-
* locations.</p>
|
|
3525
|
+
* <p>The values that you want to filter for. For example, you might want to display only Amazon
|
|
3526
|
+
* S3 locations.</p>
|
|
2588
3527
|
*/
|
|
2589
3528
|
Values: string[] | undefined;
|
|
2590
3529
|
/**
|
|
2591
3530
|
* <p>The operator that is used to compare filter values (for example, <code>Equals</code> or
|
|
2592
|
-
*
|
|
3531
|
+
* <code>Contains</code>).</p>
|
|
2593
3532
|
*/
|
|
2594
3533
|
Operator: Operator | string | undefined;
|
|
2595
3534
|
}
|
|
@@ -2608,18 +3547,18 @@ export interface ListLocationsRequest {
|
|
|
2608
3547
|
*/
|
|
2609
3548
|
NextToken?: string;
|
|
2610
3549
|
/**
|
|
2611
|
-
* <p>You can use API filters to narrow down the list of resources returned by
|
|
2612
|
-
*
|
|
2613
|
-
*
|
|
3550
|
+
* <p>You can use API filters to narrow down the list of resources returned by
|
|
3551
|
+
* <code>ListLocations</code>. For example, to retrieve all tasks on a specific source
|
|
3552
|
+
* location, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code>
|
|
3553
|
+
* and <code>Operator Equals</code>.</p>
|
|
2614
3554
|
*/
|
|
2615
3555
|
Filters?: LocationFilter[];
|
|
2616
3556
|
}
|
|
2617
3557
|
/**
|
|
2618
3558
|
* @public
|
|
2619
3559
|
* <p>Represents a single entry in a list of locations. <code>LocationListEntry</code>
|
|
2620
|
-
* returns an array that contains a list of locations when the
|
|
2621
|
-
*
|
|
2622
|
-
* operation is called.</p>
|
|
3560
|
+
* returns an array that contains a list of locations when the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html">ListLocations</a> operation is
|
|
3561
|
+
* called.</p>
|
|
2623
3562
|
*/
|
|
2624
3563
|
export interface LocationListEntry {
|
|
2625
3564
|
/**
|
|
@@ -2662,13 +3601,59 @@ export interface ListLocationsResponse {
|
|
|
2662
3601
|
*/
|
|
2663
3602
|
NextToken?: string;
|
|
2664
3603
|
}
|
|
3604
|
+
/**
|
|
3605
|
+
* @public
|
|
3606
|
+
*/
|
|
3607
|
+
export interface ListStorageSystemsRequest {
|
|
3608
|
+
/**
|
|
3609
|
+
* <p>Specifies how many results you want in the response.</p>
|
|
3610
|
+
*/
|
|
3611
|
+
MaxResults?: number;
|
|
3612
|
+
/**
|
|
3613
|
+
* <p>Specifies an opaque string that indicates the position to begin the next list of results
|
|
3614
|
+
* in the response. </p>
|
|
3615
|
+
*/
|
|
3616
|
+
NextToken?: string;
|
|
3617
|
+
}
|
|
3618
|
+
/**
|
|
3619
|
+
* @public
|
|
3620
|
+
* <p>Information that identifies an on-premises storage system that you're using with
|
|
3621
|
+
* DataSync Discovery.</p>
|
|
3622
|
+
*/
|
|
3623
|
+
export interface StorageSystemListEntry {
|
|
3624
|
+
/**
|
|
3625
|
+
* <p>The Amazon Resource Names (ARN) of an on-premises storage system that you added to
|
|
3626
|
+
* DataSync Discovery.</p>
|
|
3627
|
+
*/
|
|
3628
|
+
StorageSystemArn?: string;
|
|
3629
|
+
/**
|
|
3630
|
+
* <p>The name of an on-premises storage system that you added to DataSync Discovery.</p>
|
|
3631
|
+
*/
|
|
3632
|
+
Name?: string;
|
|
3633
|
+
}
|
|
3634
|
+
/**
|
|
3635
|
+
* @public
|
|
3636
|
+
*/
|
|
3637
|
+
export interface ListStorageSystemsResponse {
|
|
3638
|
+
/**
|
|
3639
|
+
* <p>The Amazon Resource Names ARNs) of the on-premises storage systems that you're using with
|
|
3640
|
+
* DataSync Discovery.</p>
|
|
3641
|
+
*/
|
|
3642
|
+
StorageSystems?: StorageSystemListEntry[];
|
|
3643
|
+
/**
|
|
3644
|
+
* <p>The opaque string that indicates the position to begin the next list of results in the
|
|
3645
|
+
* response.</p>
|
|
3646
|
+
*/
|
|
3647
|
+
NextToken?: string;
|
|
3648
|
+
}
|
|
2665
3649
|
/**
|
|
2666
3650
|
* @public
|
|
2667
3651
|
* <p>ListTagsForResourceRequest</p>
|
|
2668
3652
|
*/
|
|
2669
3653
|
export interface ListTagsForResourceRequest {
|
|
2670
3654
|
/**
|
|
2671
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the resource that you want tag information
|
|
3655
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the resource that you want tag information
|
|
3656
|
+
* on.</p>
|
|
2672
3657
|
*/
|
|
2673
3658
|
ResourceArn: string | undefined;
|
|
2674
3659
|
/**
|
|
@@ -2676,7 +3661,8 @@ export interface ListTagsForResourceRequest {
|
|
|
2676
3661
|
*/
|
|
2677
3662
|
MaxResults?: number;
|
|
2678
3663
|
/**
|
|
2679
|
-
* <p>Specifies an opaque string that indicates the position to begin the next list of
|
|
3664
|
+
* <p>Specifies an opaque string that indicates the position to begin the next list of
|
|
3665
|
+
* results in the response.</p>
|
|
2680
3666
|
*/
|
|
2681
3667
|
NextToken?: string;
|
|
2682
3668
|
}
|
|
@@ -2690,7 +3676,8 @@ export interface ListTagsForResourceResponse {
|
|
|
2690
3676
|
*/
|
|
2691
3677
|
Tags?: TagListEntry[];
|
|
2692
3678
|
/**
|
|
2693
|
-
* <p>The opaque string that indicates the position to begin the next list of results in the
|
|
3679
|
+
* <p>The opaque string that indicates the position to begin the next list of results in the
|
|
3680
|
+
* response.</p>
|
|
2694
3681
|
*/
|
|
2695
3682
|
NextToken?: string;
|
|
2696
3683
|
}
|
|
@@ -2717,8 +3704,7 @@ export interface ListTaskExecutionsRequest {
|
|
|
2717
3704
|
* @public
|
|
2718
3705
|
* <p>Represents a single entry in a list of task executions.
|
|
2719
3706
|
* <code>TaskExecutionListEntry</code> returns an array that contains a list of specific
|
|
2720
|
-
* invocations of a task when the
|
|
2721
|
-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html">ListTaskExecutions</a>
|
|
3707
|
+
* invocations of a task when the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html">ListTaskExecutions</a>
|
|
2722
3708
|
* operation is called.</p>
|
|
2723
3709
|
*/
|
|
2724
3710
|
export interface TaskExecutionListEntry {
|
|
@@ -2760,16 +3746,17 @@ export declare const TaskFilterName: {
|
|
|
2760
3746
|
export type TaskFilterName = (typeof TaskFilterName)[keyof typeof TaskFilterName];
|
|
2761
3747
|
/**
|
|
2762
3748
|
* @public
|
|
2763
|
-
* <p>You can use API filters to narrow down the list of resources returned by
|
|
2764
|
-
*
|
|
2765
|
-
*
|
|
2766
|
-
*
|
|
2767
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html">filtering DataSync
|
|
3749
|
+
* <p>You can use API filters to narrow down the list of resources returned by
|
|
3750
|
+
* <code>ListTasks</code>. For example, to retrieve all tasks on a source location, you can use
|
|
3751
|
+
* <code>ListTasks</code> with filter name <code>LocationId</code> and <code>Operator
|
|
3752
|
+
* Equals</code> with the ARN for the location.</p>
|
|
3753
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html">filtering DataSync
|
|
3754
|
+
* resources</a>.</p>
|
|
2768
3755
|
*/
|
|
2769
3756
|
export interface TaskFilter {
|
|
2770
3757
|
/**
|
|
2771
|
-
* <p>The name of the filter being used. Each API call supports a list of filters that are
|
|
2772
|
-
* for it. For example, <code>LocationId</code> for <code>ListTasks</code>.</p>
|
|
3758
|
+
* <p>The name of the filter being used. Each API call supports a list of filters that are
|
|
3759
|
+
* available for it. For example, <code>LocationId</code> for <code>ListTasks</code>.</p>
|
|
2773
3760
|
*/
|
|
2774
3761
|
Name: TaskFilterName | string | undefined;
|
|
2775
3762
|
/**
|
|
@@ -2779,7 +3766,7 @@ export interface TaskFilter {
|
|
|
2779
3766
|
Values: string[] | undefined;
|
|
2780
3767
|
/**
|
|
2781
3768
|
* <p>The operator that is used to compare filter values (for example, <code>Equals</code> or
|
|
2782
|
-
*
|
|
3769
|
+
* <code>Contains</code>).</p>
|
|
2783
3770
|
*/
|
|
2784
3771
|
Operator: Operator | string | undefined;
|
|
2785
3772
|
}
|
|
@@ -2798,18 +3785,18 @@ export interface ListTasksRequest {
|
|
|
2798
3785
|
*/
|
|
2799
3786
|
NextToken?: string;
|
|
2800
3787
|
/**
|
|
2801
|
-
* <p>You can use API filters to narrow down the list of resources returned by
|
|
2802
|
-
*
|
|
2803
|
-
* with filter name <code>LocationId</code> and <code>Operator
|
|
2804
|
-
*
|
|
3788
|
+
* <p>You can use API filters to narrow down the list of resources returned by
|
|
3789
|
+
* <code>ListTasks</code>. For example, to retrieve all tasks on a specific source location,
|
|
3790
|
+
* you can use <code>ListTasks</code> with filter name <code>LocationId</code> and <code>Operator
|
|
3791
|
+
* Equals</code> with the ARN for the location.</p>
|
|
2805
3792
|
*/
|
|
2806
3793
|
Filters?: TaskFilter[];
|
|
2807
3794
|
}
|
|
2808
3795
|
/**
|
|
2809
3796
|
* @public
|
|
2810
3797
|
* <p>Represents a single entry in a list of tasks. <code>TaskListEntry</code> returns an
|
|
2811
|
-
* array that contains a list of tasks when the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTasks.html">ListTasks</a> operation is called.
|
|
2812
|
-
*
|
|
3798
|
+
* array that contains a list of tasks when the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTasks.html">ListTasks</a> operation is called. A
|
|
3799
|
+
* task includes the source and destination file systems to sync and the options to use for the
|
|
2813
3800
|
* tasks.</p>
|
|
2814
3801
|
*/
|
|
2815
3802
|
export interface TaskListEntry {
|
|
@@ -2841,6 +3828,59 @@ export interface ListTasksResponse {
|
|
|
2841
3828
|
*/
|
|
2842
3829
|
NextToken?: string;
|
|
2843
3830
|
}
|
|
3831
|
+
/**
|
|
3832
|
+
* @public
|
|
3833
|
+
*/
|
|
3834
|
+
export interface RemoveStorageSystemRequest {
|
|
3835
|
+
/**
|
|
3836
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the storage system that you want to
|
|
3837
|
+
* permanently remove from DataSync Discovery.</p>
|
|
3838
|
+
*/
|
|
3839
|
+
StorageSystemArn: string | undefined;
|
|
3840
|
+
}
|
|
3841
|
+
/**
|
|
3842
|
+
* @public
|
|
3843
|
+
*/
|
|
3844
|
+
export interface RemoveStorageSystemResponse {
|
|
3845
|
+
}
|
|
3846
|
+
/**
|
|
3847
|
+
* @public
|
|
3848
|
+
*/
|
|
3849
|
+
export interface StartDiscoveryJobRequest {
|
|
3850
|
+
/**
|
|
3851
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the on-premises storage system that you want
|
|
3852
|
+
* to run the discovery job on.</p>
|
|
3853
|
+
*/
|
|
3854
|
+
StorageSystemArn: string | undefined;
|
|
3855
|
+
/**
|
|
3856
|
+
* <p>Specifies in minutes how long you want the discovery job to run.</p>
|
|
3857
|
+
* <note>
|
|
3858
|
+
* <p>For more accurate recommendations, we recommend a duration of at least 14 days. Longer
|
|
3859
|
+
* durations allow time to collect a sufficient number of data points and provide a realistic
|
|
3860
|
+
* representation of storage performance and utilization.</p>
|
|
3861
|
+
* </note>
|
|
3862
|
+
*/
|
|
3863
|
+
CollectionDurationMinutes: number | undefined;
|
|
3864
|
+
/**
|
|
3865
|
+
* <p>Specifies a client token to make sure requests with this API operation are idempotent. If
|
|
3866
|
+
* you don't specify a client token, DataSync generates one for you automatically.</p>
|
|
3867
|
+
*/
|
|
3868
|
+
ClientToken?: string;
|
|
3869
|
+
/**
|
|
3870
|
+
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
|
|
3871
|
+
* resources.</p>
|
|
3872
|
+
*/
|
|
3873
|
+
Tags?: TagListEntry[];
|
|
3874
|
+
}
|
|
3875
|
+
/**
|
|
3876
|
+
* @public
|
|
3877
|
+
*/
|
|
3878
|
+
export interface StartDiscoveryJobResponse {
|
|
3879
|
+
/**
|
|
3880
|
+
* <p>The ARN of the discovery job that you started.</p>
|
|
3881
|
+
*/
|
|
3882
|
+
DiscoveryJobArn?: string;
|
|
3883
|
+
}
|
|
2844
3884
|
/**
|
|
2845
3885
|
* @public
|
|
2846
3886
|
* <p>StartTaskExecutionRequest</p>
|
|
@@ -2872,9 +3912,11 @@ export interface StartTaskExecutionRequest {
|
|
|
2872
3912
|
*/
|
|
2873
3913
|
Excludes?: FilterRule[];
|
|
2874
3914
|
/**
|
|
2875
|
-
* <p>Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing
|
|
3915
|
+
* <p>Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing
|
|
3916
|
+
* the task execution.</p>
|
|
2876
3917
|
* <p>
|
|
2877
|
-
* <i>Tags</i> are key-value pairs that help you manage, filter, and search for
|
|
3918
|
+
* <i>Tags</i> are key-value pairs that help you manage, filter, and search for
|
|
3919
|
+
* your DataSync resources.</p>
|
|
2878
3920
|
*/
|
|
2879
3921
|
Tags?: TagListEntry[];
|
|
2880
3922
|
}
|
|
@@ -2888,6 +3930,21 @@ export interface StartTaskExecutionResponse {
|
|
|
2888
3930
|
*/
|
|
2889
3931
|
TaskExecutionArn?: string;
|
|
2890
3932
|
}
|
|
3933
|
+
/**
|
|
3934
|
+
* @public
|
|
3935
|
+
*/
|
|
3936
|
+
export interface StopDiscoveryJobRequest {
|
|
3937
|
+
/**
|
|
3938
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the discovery job that you want to stop.
|
|
3939
|
+
* </p>
|
|
3940
|
+
*/
|
|
3941
|
+
DiscoveryJobArn: string | undefined;
|
|
3942
|
+
}
|
|
3943
|
+
/**
|
|
3944
|
+
* @public
|
|
3945
|
+
*/
|
|
3946
|
+
export interface StopDiscoveryJobResponse {
|
|
3947
|
+
}
|
|
2891
3948
|
/**
|
|
2892
3949
|
* @public
|
|
2893
3950
|
* <p>TagResourceRequest</p>
|
|
@@ -2913,7 +3970,8 @@ export interface TagResourceResponse {
|
|
|
2913
3970
|
*/
|
|
2914
3971
|
export interface UntagResourceRequest {
|
|
2915
3972
|
/**
|
|
2916
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the resource to remove the tags
|
|
3973
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the resource to remove the tags
|
|
3974
|
+
* from.</p>
|
|
2917
3975
|
*/
|
|
2918
3976
|
ResourceArn: string | undefined;
|
|
2919
3977
|
/**
|
|
@@ -2945,6 +4003,26 @@ export interface UpdateAgentRequest {
|
|
|
2945
4003
|
*/
|
|
2946
4004
|
export interface UpdateAgentResponse {
|
|
2947
4005
|
}
|
|
4006
|
+
/**
|
|
4007
|
+
* @public
|
|
4008
|
+
*/
|
|
4009
|
+
export interface UpdateDiscoveryJobRequest {
|
|
4010
|
+
/**
|
|
4011
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the discovery job that you want to
|
|
4012
|
+
* update.</p>
|
|
4013
|
+
*/
|
|
4014
|
+
DiscoveryJobArn: string | undefined;
|
|
4015
|
+
/**
|
|
4016
|
+
* <p>Specifies in minutes how long that you want the discovery job to run. (You can't set this
|
|
4017
|
+
* parameter to less than the number of minutes that the job has already run for.)</p>
|
|
4018
|
+
*/
|
|
4019
|
+
CollectionDurationMinutes: number | undefined;
|
|
4020
|
+
}
|
|
4021
|
+
/**
|
|
4022
|
+
* @public
|
|
4023
|
+
*/
|
|
4024
|
+
export interface UpdateDiscoveryJobResponse {
|
|
4025
|
+
}
|
|
2948
4026
|
/**
|
|
2949
4027
|
* @public
|
|
2950
4028
|
*/
|
|
@@ -3033,15 +4111,16 @@ export interface UpdateLocationNfsRequest {
|
|
|
3033
4111
|
* can be mounted by other NFS clients in your network.</p>
|
|
3034
4112
|
* <p>To see all the paths exported by your NFS server, run "<code>showmount -e
|
|
3035
4113
|
* nfs-server-name</code>" from an NFS client that has access to your server. You can specify
|
|
3036
|
-
*
|
|
3037
|
-
*
|
|
4114
|
+
* any directory that appears in the results, and any subdirectory of that directory. Ensure that
|
|
4115
|
+
* the NFS export is accessible without Kerberos authentication. </p>
|
|
3038
4116
|
* <p>To transfer all the data in the folder that you specified, DataSync must have
|
|
3039
4117
|
* permissions to read all the data. To ensure this, either configure the NFS export with
|
|
3040
|
-
* <code>no_root_squash</code>, or ensure that the files you want DataSync to
|
|
3041
|
-
*
|
|
3042
|
-
*
|
|
4118
|
+
* <code>no_root_squash</code>, or ensure that the files you want DataSync to access
|
|
4119
|
+
* have permissions that allow read access for all users. Doing either option enables the agent
|
|
4120
|
+
* to read the files. For the agent to access directories, you must additionally enable all
|
|
3043
4121
|
* execute access.</p>
|
|
3044
|
-
* <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
|
|
4122
|
+
* <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
|
|
4123
|
+
* Snowcone</a> for more information.</p>
|
|
3045
4124
|
* <p>For information about NFS export configuration, see 18.7. The /etc/exports
|
|
3046
4125
|
* Configuration File in the Red Hat Enterprise Linux documentation.</p>
|
|
3047
4126
|
*/
|
|
@@ -3095,14 +4174,15 @@ export interface UpdateLocationObjectStorageRequest {
|
|
|
3095
4174
|
*/
|
|
3096
4175
|
SecretKey?: string;
|
|
3097
4176
|
/**
|
|
3098
|
-
* <p>Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can
|
|
3099
|
-
* your location.</p>
|
|
4177
|
+
* <p>Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can
|
|
4178
|
+
* securely connect with your location.</p>
|
|
3100
4179
|
*/
|
|
3101
4180
|
AgentArns?: string[];
|
|
3102
4181
|
/**
|
|
3103
4182
|
* <p>Specifies a certificate to authenticate with an object storage system that uses a private
|
|
3104
4183
|
* or self-signed certificate authority (CA). You must specify a Base64-encoded <code>.pem</code>
|
|
3105
|
-
* file (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>). The
|
|
4184
|
+
* file (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>). The
|
|
4185
|
+
* certificate can be up to 32768 bytes (before Base64 encoding).</p>
|
|
3106
4186
|
* <p>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</p>
|
|
3107
4187
|
* <p>Updating the certificate doesn't interfere with tasks that you have in progress.</p>
|
|
3108
4188
|
*/
|
|
@@ -3129,7 +4209,7 @@ export interface UpdateLocationSmbRequest {
|
|
|
3129
4209
|
* <note>
|
|
3130
4210
|
* <p>
|
|
3131
4211
|
* <code>Subdirectory</code> must be specified with forward slashes. For example,
|
|
3132
|
-
*
|
|
4212
|
+
* <code>/path/to/folder</code>.</p>
|
|
3133
4213
|
* </note>
|
|
3134
4214
|
* <p>To transfer all the data in the folder that you specified, DataSync must have
|
|
3135
4215
|
* permissions to mount the SMB share and to access all the data in that share. To ensure this,
|
|
@@ -3138,7 +4218,7 @@ export interface UpdateLocationSmbRequest {
|
|
|
3138
4218
|
* <li>
|
|
3139
4219
|
* <p>Ensure that the user/password specified belongs to the user who can mount the share
|
|
3140
4220
|
* and who has the appropriate permissions for all of the files and directories that you want
|
|
3141
|
-
*
|
|
4221
|
+
* DataSync to access.</p>
|
|
3142
4222
|
* </li>
|
|
3143
4223
|
* <li>
|
|
3144
4224
|
* <p>Use credentials of a member of the Backup Operators group to mount the share. </p>
|
|
@@ -3177,6 +4257,44 @@ export interface UpdateLocationSmbRequest {
|
|
|
3177
4257
|
*/
|
|
3178
4258
|
export interface UpdateLocationSmbResponse {
|
|
3179
4259
|
}
|
|
4260
|
+
/**
|
|
4261
|
+
* @public
|
|
4262
|
+
*/
|
|
4263
|
+
export interface UpdateStorageSystemRequest {
|
|
4264
|
+
/**
|
|
4265
|
+
* <p>Specifies the ARN of the on-premises storage system that you want reconfigure.</p>
|
|
4266
|
+
*/
|
|
4267
|
+
StorageSystemArn: string | undefined;
|
|
4268
|
+
/**
|
|
4269
|
+
* <p>Specifies the server name and network port required to connect with your on-premises
|
|
4270
|
+
* storage system's management interface.</p>
|
|
4271
|
+
*/
|
|
4272
|
+
ServerConfiguration?: DiscoveryServerConfiguration;
|
|
4273
|
+
/**
|
|
4274
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads
|
|
4275
|
+
* your on-premises storage system.</p>
|
|
4276
|
+
*/
|
|
4277
|
+
AgentArns?: string[];
|
|
4278
|
+
/**
|
|
4279
|
+
* <p>Specifies a familiar name for your on-premises storage system.</p>
|
|
4280
|
+
*/
|
|
4281
|
+
Name?: string;
|
|
4282
|
+
/**
|
|
4283
|
+
* <p>Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging
|
|
4284
|
+
* discovery job events.</p>
|
|
4285
|
+
*/
|
|
4286
|
+
CloudWatchLogGroupArn?: string;
|
|
4287
|
+
/**
|
|
4288
|
+
* <p>Specifies the user name and password for accessing your on-premises storage system's
|
|
4289
|
+
* management interface.</p>
|
|
4290
|
+
*/
|
|
4291
|
+
Credentials?: Credentials;
|
|
4292
|
+
}
|
|
4293
|
+
/**
|
|
4294
|
+
* @public
|
|
4295
|
+
*/
|
|
4296
|
+
export interface UpdateStorageSystemResponse {
|
|
4297
|
+
}
|
|
3180
4298
|
/**
|
|
3181
4299
|
* @public
|
|
3182
4300
|
* <p>UpdateTaskResponse</p>
|
|
@@ -3195,7 +4313,8 @@ export interface UpdateTaskRequest {
|
|
|
3195
4313
|
*/
|
|
3196
4314
|
Options?: Options;
|
|
3197
4315
|
/**
|
|
3198
|
-
* <p>Specifies a list of filter rules that exclude specific data during your transfer. For more
|
|
4316
|
+
* <p>Specifies a list of filter rules that exclude specific data during your transfer. For more
|
|
4317
|
+
* information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
3199
4318
|
*/
|
|
3200
4319
|
Excludes?: FilterRule[];
|
|
3201
4320
|
/**
|
|
@@ -3215,7 +4334,8 @@ export interface UpdateTaskRequest {
|
|
|
3215
4334
|
*/
|
|
3216
4335
|
CloudWatchLogGroupArn?: string;
|
|
3217
4336
|
/**
|
|
3218
|
-
* <p>Specifies a list of filter rules that include specific data during your transfer. For more
|
|
4337
|
+
* <p>Specifies a list of filter rules that include specific data during your transfer. For more
|
|
4338
|
+
* information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
3219
4339
|
*/
|
|
3220
4340
|
Includes?: FilterRule[];
|
|
3221
4341
|
}
|
|
@@ -3229,7 +4349,8 @@ export interface UpdateTaskResponse {
|
|
|
3229
4349
|
*/
|
|
3230
4350
|
export interface UpdateTaskExecutionRequest {
|
|
3231
4351
|
/**
|
|
3232
|
-
* <p>
|
|
4352
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the task execution that you're
|
|
4353
|
+
* updating.</p>
|
|
3233
4354
|
*/
|
|
3234
4355
|
TaskExecutionArn: string | undefined;
|
|
3235
4356
|
/**
|
|
@@ -3246,6 +4367,14 @@ export interface UpdateTaskExecutionRequest {
|
|
|
3246
4367
|
*/
|
|
3247
4368
|
export interface UpdateTaskExecutionResponse {
|
|
3248
4369
|
}
|
|
4370
|
+
/**
|
|
4371
|
+
* @internal
|
|
4372
|
+
*/
|
|
4373
|
+
export declare const CredentialsFilterSensitiveLog: (obj: Credentials) => any;
|
|
4374
|
+
/**
|
|
4375
|
+
* @internal
|
|
4376
|
+
*/
|
|
4377
|
+
export declare const AddStorageSystemRequestFilterSensitiveLog: (obj: AddStorageSystemRequest) => any;
|
|
3249
4378
|
/**
|
|
3250
4379
|
* @internal
|
|
3251
4380
|
*/
|
|
@@ -3290,3 +4419,7 @@ export declare const UpdateLocationObjectStorageRequestFilterSensitiveLog: (obj:
|
|
|
3290
4419
|
* @internal
|
|
3291
4420
|
*/
|
|
3292
4421
|
export declare const UpdateLocationSmbRequestFilterSensitiveLog: (obj: UpdateLocationSmbRequest) => any;
|
|
4422
|
+
/**
|
|
4423
|
+
* @internal
|
|
4424
|
+
*/
|
|
4425
|
+
export declare const UpdateStorageSystemRequestFilterSensitiveLog: (obj: UpdateStorageSystemRequest) => any;
|