@aws-sdk/client-s3files 3.1026.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/LICENSE +201 -0
- package/README.md +328 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +46 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/index.js +477 -0
- package/dist-cjs/models/S3FilesServiceException.js +12 -0
- package/dist-cjs/models/errors.js +98 -0
- package/dist-cjs/runtimeConfig.browser.js +38 -0
- package/dist-cjs/runtimeConfig.js +54 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +44 -0
- package/dist-cjs/schemas/schemas_0.js +507 -0
- package/dist-es/S3Files.js +59 -0
- package/dist-es/S3FilesClient.js +50 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
- package/dist-es/commands/CreateAccessPointCommand.js +16 -0
- package/dist-es/commands/CreateFileSystemCommand.js +16 -0
- package/dist-es/commands/CreateMountTargetCommand.js +16 -0
- package/dist-es/commands/DeleteAccessPointCommand.js +16 -0
- package/dist-es/commands/DeleteFileSystemCommand.js +16 -0
- package/dist-es/commands/DeleteFileSystemPolicyCommand.js +16 -0
- package/dist-es/commands/DeleteMountTargetCommand.js +16 -0
- package/dist-es/commands/GetAccessPointCommand.js +16 -0
- package/dist-es/commands/GetFileSystemCommand.js +16 -0
- package/dist-es/commands/GetFileSystemPolicyCommand.js +16 -0
- package/dist-es/commands/GetMountTargetCommand.js +16 -0
- package/dist-es/commands/GetSynchronizationConfigurationCommand.js +16 -0
- package/dist-es/commands/ListAccessPointsCommand.js +16 -0
- package/dist-es/commands/ListFileSystemsCommand.js +16 -0
- package/dist-es/commands/ListMountTargetsCommand.js +16 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +16 -0
- package/dist-es/commands/PutFileSystemPolicyCommand.js +16 -0
- package/dist-es/commands/PutSynchronizationConfigurationCommand.js +16 -0
- package/dist-es/commands/TagResourceCommand.js +16 -0
- package/dist-es/commands/UntagResourceCommand.js +16 -0
- package/dist-es/commands/UpdateMountTargetCommand.js +16 -0
- package/dist-es/commands/index.js +21 -0
- package/dist-es/endpoint/EndpointParameters.js +11 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +9 -0
- package/dist-es/models/S3FilesServiceException.js +8 -0
- package/dist-es/models/enums.js +17 -0
- package/dist-es/models/errors.js +89 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListAccessPointsPaginator.js +4 -0
- package/dist-es/pagination/ListFileSystemsPaginator.js +4 -0
- package/dist-es/pagination/ListMountTargetsPaginator.js +4 -0
- package/dist-es/pagination/ListTagsForResourcePaginator.js +4 -0
- package/dist-es/pagination/index.js +5 -0
- package/dist-es/runtimeConfig.browser.js +33 -0
- package/dist-es/runtimeConfig.js +49 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +40 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-es/schemas/schemas_0.js +503 -0
- package/dist-types/S3Files.d.ts +187 -0
- package/dist-types/S3FilesClient.d.ts +208 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commands/CreateAccessPointCommand.d.ts +141 -0
- package/dist-types/commands/CreateFileSystemCommand.d.ts +120 -0
- package/dist-types/commands/CreateMountTargetCommand.d.ts +112 -0
- package/dist-types/commands/DeleteAccessPointCommand.d.ts +87 -0
- package/dist-types/commands/DeleteFileSystemCommand.d.ts +88 -0
- package/dist-types/commands/DeleteFileSystemPolicyCommand.d.ts +84 -0
- package/dist-types/commands/DeleteMountTargetCommand.d.ts +87 -0
- package/dist-types/commands/GetAccessPointCommand.d.ts +113 -0
- package/dist-types/commands/GetFileSystemCommand.d.ts +103 -0
- package/dist-types/commands/GetFileSystemPolicyCommand.d.ts +87 -0
- package/dist-types/commands/GetMountTargetCommand.d.ts +99 -0
- package/dist-types/commands/GetSynchronizationConfigurationCommand.d.ts +98 -0
- package/dist-types/commands/ListAccessPointsCommand.d.ts +113 -0
- package/dist-types/commands/ListFileSystemsCommand.d.ts +98 -0
- package/dist-types/commands/ListMountTargetsCommand.d.ts +104 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +94 -0
- package/dist-types/commands/PutFileSystemPolicyCommand.d.ts +85 -0
- package/dist-types/commands/PutSynchronizationConfigurationCommand.d.ts +100 -0
- package/dist-types/commands/TagResourceCommand.d.ts +90 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +87 -0
- package/dist-types/commands/UpdateMountTargetCommand.d.ts +102 -0
- package/dist-types/commands/index.d.ts +21 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +44 -0
- package/dist-types/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +17 -0
- package/dist-types/models/S3FilesServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +41 -0
- package/dist-types/models/errors.d.ts +114 -0
- package/dist-types/models/models_0.d.ts +1185 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListAccessPointsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListFileSystemsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListMountTargetsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListTagsForResourcePaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +5 -0
- package/dist-types/runtimeConfig.browser.d.ts +55 -0
- package/dist-types/runtimeConfig.d.ts +55 -0
- package/dist-types/runtimeConfig.native.d.ts +54 -0
- package/dist-types/runtimeConfig.shared.d.ts +27 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +81 -0
- package/dist-types/ts3.4/S3Files.d.ts +396 -0
- package/dist-types/ts3.4/S3FilesClient.d.ts +244 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreateAccessPointCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateFileSystemCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateMountTargetCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteAccessPointCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/DeleteFileSystemCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/DeleteFileSystemPolicyCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/DeleteMountTargetCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/GetAccessPointCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetFileSystemCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetFileSystemPolicyCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetMountTargetCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetSynchronizationConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListAccessPointsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListFileSystemsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListMountTargetsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutFileSystemPolicyCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutSynchronizationConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/UpdateMountTargetCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +21 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +12 -0
- package/dist-types/ts3.4/models/S3FilesServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/enums.d.ts +21 -0
- package/dist-types/ts3.4/models/errors.d.ts +50 -0
- package/dist-types/ts3.4/models/models_0.d.ts +279 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListAccessPointsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListFileSystemsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListMountTargetsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListTagsForResourcePaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +5 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +100 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +95 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +104 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +30 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +80 -0
- package/package.json +100 -0
|
@@ -0,0 +1,1185 @@
|
|
|
1
|
+
import type { ImportTrigger, IpAddressType, LifeCycleState } from "./enums";
|
|
2
|
+
/**
|
|
3
|
+
* <p>Specifies the POSIX identity with uid, gid, and secondary group IDs for user enforcement.</p>
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface PosixUser {
|
|
7
|
+
/**
|
|
8
|
+
* <p>The POSIX user ID.</p>
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
uid: number | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* <p>The POSIX group ID.</p>
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
gid: number | undefined;
|
|
17
|
+
/**
|
|
18
|
+
* <p>An array of secondary POSIX group IDs.</p>
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
secondaryGids?: number[] | undefined;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* <p>Specifies the permissions to set on newly created directories within the file system.</p>
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
export interface CreationPermissions {
|
|
28
|
+
/**
|
|
29
|
+
* <p>The POSIX user ID to assign to newly created directories.</p>
|
|
30
|
+
* @public
|
|
31
|
+
*/
|
|
32
|
+
ownerUid: number | undefined;
|
|
33
|
+
/**
|
|
34
|
+
* <p>The POSIX group ID to assign to newly created directories.</p>
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
ownerGid: number | undefined;
|
|
38
|
+
/**
|
|
39
|
+
* <p>The octal permissions to assign to newly created directories.</p>
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
permissions: string | undefined;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* <p>Specifies the root directory path and optional creation permissions for newly created directories.</p>
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
export interface RootDirectory {
|
|
49
|
+
/**
|
|
50
|
+
* <p>The path to use as the root directory for the access point.</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
path?: string | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* <p>The permissions to set on newly created directories.</p>
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
creationPermissions?: CreationPermissions | undefined;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* <p>Contains information about an S3 File System Access Point returned in list operations.</p>
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
export interface ListAccessPointsDescription {
|
|
65
|
+
/**
|
|
66
|
+
* <p>The Amazon Resource Name (ARN) of the access point.</p>
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
accessPointArn: string | undefined;
|
|
70
|
+
/**
|
|
71
|
+
* <p>The ID of the access point.</p>
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
accessPointId: string | undefined;
|
|
75
|
+
/**
|
|
76
|
+
* <p>The ID of the S3 File System.</p>
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
fileSystemId: string | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* <p>The current status of the access point.</p>
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
status: LifeCycleState | undefined;
|
|
85
|
+
/**
|
|
86
|
+
* <p>The Amazon Web Services account ID of the access point owner.</p>
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
ownerId: string | undefined;
|
|
90
|
+
/**
|
|
91
|
+
* <p>The POSIX identity configured for this access point.</p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
posixUser?: PosixUser | undefined;
|
|
95
|
+
/**
|
|
96
|
+
* <p>The root directory configuration for this access point.</p>
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
rootDirectory?: RootDirectory | undefined;
|
|
100
|
+
/**
|
|
101
|
+
* <p>The name of the access point.</p>
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
name?: string | undefined;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* <p>A key-value pair for resource tagging.</p>
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
export interface Tag {
|
|
111
|
+
/**
|
|
112
|
+
* <p>The tag key. The key can't start with <code>aws:</code>.</p>
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
key: string | undefined;
|
|
116
|
+
/**
|
|
117
|
+
* <p>The tag value.</p>
|
|
118
|
+
* @public
|
|
119
|
+
*/
|
|
120
|
+
value: string | undefined;
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
export interface CreateAccessPointRequest {
|
|
126
|
+
/**
|
|
127
|
+
* <p>A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Web Services ignores the request, but does not return an error.</p>
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
clientToken?: string | undefined;
|
|
131
|
+
/**
|
|
132
|
+
* <p>An array of key-value pairs to apply to the access point for resource tagging.</p>
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
tags?: Tag[] | undefined;
|
|
136
|
+
/**
|
|
137
|
+
* <p>The ID or Amazon Resource Name (ARN) of the S3 File System.</p>
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
fileSystemId: string | undefined;
|
|
141
|
+
/**
|
|
142
|
+
* <p>The POSIX identity with uid, gid, and secondary group IDs for user enforcement when accessing the file system through this access point.</p>
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
posixUser?: PosixUser | undefined;
|
|
146
|
+
/**
|
|
147
|
+
* <p>The root directory path for the access point, with optional creation permissions for newly created directories.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
rootDirectory?: RootDirectory | undefined;
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
export interface CreateAccessPointResponse {
|
|
156
|
+
/**
|
|
157
|
+
* <p>The Amazon Resource Name (ARN) of the access point.</p>
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
accessPointArn: string | undefined;
|
|
161
|
+
/**
|
|
162
|
+
* <p>The ID of the access point.</p>
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
accessPointId: string | undefined;
|
|
166
|
+
/**
|
|
167
|
+
* <p>The client token that was provided in the request.</p>
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
clientToken: string | undefined;
|
|
171
|
+
/**
|
|
172
|
+
* <p>The ID of the S3 File System.</p>
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
fileSystemId: string | undefined;
|
|
176
|
+
/**
|
|
177
|
+
* <p>The current status of the access point.</p>
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
180
|
+
status: LifeCycleState | undefined;
|
|
181
|
+
/**
|
|
182
|
+
* <p>The Amazon Web Services account ID of the access point owner.</p>
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
ownerId: string | undefined;
|
|
186
|
+
/**
|
|
187
|
+
* <p>The POSIX identity configured for this access point.</p>
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
posixUser?: PosixUser | undefined;
|
|
191
|
+
/**
|
|
192
|
+
* <p>The root directory configuration for this access point.</p>
|
|
193
|
+
* @public
|
|
194
|
+
*/
|
|
195
|
+
rootDirectory?: RootDirectory | undefined;
|
|
196
|
+
/**
|
|
197
|
+
* <p>The tags associated with the access point.</p>
|
|
198
|
+
* @public
|
|
199
|
+
*/
|
|
200
|
+
tags?: Tag[] | undefined;
|
|
201
|
+
/**
|
|
202
|
+
* <p>The name of the access point.</p>
|
|
203
|
+
* @public
|
|
204
|
+
*/
|
|
205
|
+
name?: string | undefined;
|
|
206
|
+
}
|
|
207
|
+
/**
|
|
208
|
+
* @public
|
|
209
|
+
*/
|
|
210
|
+
export interface CreateFileSystemRequest {
|
|
211
|
+
/**
|
|
212
|
+
* <p>The Amazon Resource Name (ARN) of the S3 bucket that will be accessible through the file system. The bucket must exist and be in the same Amazon Web Services Region as the file system.</p>
|
|
213
|
+
* @public
|
|
214
|
+
*/
|
|
215
|
+
bucket: string | undefined;
|
|
216
|
+
/**
|
|
217
|
+
* <p>An optional prefix within the S3 bucket to scope the file system access. If specified, the file system provides access only to objects with keys that begin with this prefix. If not specified, the file system provides access to the entire bucket.</p>
|
|
218
|
+
* @public
|
|
219
|
+
*/
|
|
220
|
+
prefix?: string | undefined;
|
|
221
|
+
/**
|
|
222
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure idempotent creation. Up to 64 ASCII characters are allowed. If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>
|
|
223
|
+
* @public
|
|
224
|
+
*/
|
|
225
|
+
clientToken?: string | undefined;
|
|
226
|
+
/**
|
|
227
|
+
* <p>The ARN, key ID, or alias of the KMS key to use for encryption. If not specified, the service uses a service-owned key for encryption. You can specify a KMS key using the following formats: key ID, ARN, key alias, or key alias ARN. If you use <code>KmsKeyId</code>, the file system will be encrypted.</p>
|
|
228
|
+
* @public
|
|
229
|
+
*/
|
|
230
|
+
kmsKeyId?: string | undefined;
|
|
231
|
+
/**
|
|
232
|
+
* <p>The ARN of the IAM role that grants the S3 Files service permission to read and write data between the file system and the S3 bucket. This role must have the necessary permissions to access the specified bucket and prefix.</p>
|
|
233
|
+
* @public
|
|
234
|
+
*/
|
|
235
|
+
roleArn: string | undefined;
|
|
236
|
+
/**
|
|
237
|
+
* <p>An array of key-value pairs to apply as tags to the file system resource. Each tag is a user-defined key-value pair. You can use tags to categorize and manage your file systems. Each key must be unique for the resource.</p>
|
|
238
|
+
* @public
|
|
239
|
+
*/
|
|
240
|
+
tags?: Tag[] | undefined;
|
|
241
|
+
/**
|
|
242
|
+
* <p>Set to true to acknowledge and accept any warnings about the bucket configuration. If not specified, the operation may fail if there are bucket configuration warnings.</p>
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
245
|
+
acceptBucketWarning?: boolean | undefined;
|
|
246
|
+
}
|
|
247
|
+
/**
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
250
|
+
export interface CreateFileSystemResponse {
|
|
251
|
+
/**
|
|
252
|
+
* <p>The time when the file system was created, in seconds since 1970-01-01T00:00:00Z (Unix epoch time).</p>
|
|
253
|
+
* @public
|
|
254
|
+
*/
|
|
255
|
+
creationTime?: Date | undefined;
|
|
256
|
+
/**
|
|
257
|
+
* <p>The ARN for the S3 file system, in the format <code>arn:aws:s3files:region:account-id:file-system/file-system-id</code>.</p>
|
|
258
|
+
* @public
|
|
259
|
+
*/
|
|
260
|
+
fileSystemArn?: string | undefined;
|
|
261
|
+
/**
|
|
262
|
+
* <p>The ID of the file system, assigned by S3 Files. This ID is used to reference the file system in subsequent API calls.</p>
|
|
263
|
+
* @public
|
|
264
|
+
*/
|
|
265
|
+
fileSystemId?: string | undefined;
|
|
266
|
+
/**
|
|
267
|
+
* <p>The Amazon Resource Name (ARN) of the S3 bucket associated with the file system.</p>
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
bucket?: string | undefined;
|
|
271
|
+
/**
|
|
272
|
+
* <p>The prefix within the S3 bucket that scopes the file system access.</p>
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
prefix?: string | undefined;
|
|
276
|
+
/**
|
|
277
|
+
* <p>The client token used for idempotency.</p>
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
clientToken?: string | undefined;
|
|
281
|
+
/**
|
|
282
|
+
* <p>The ARN or alias of the KMS key used for encryption.</p>
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
kmsKeyId?: string | undefined;
|
|
286
|
+
/**
|
|
287
|
+
* <p>The lifecycle state of the file system. Valid values are: <code>AVAILABLE</code> (the file system is available for use), <code>CREATING</code> (the file system is being created), <code>DELETING</code> (the file system is being deleted), <code>DELETED</code> (the file system has been deleted), <code>ERROR</code> (the file system is in an error state), or <code>UPDATING</code> (the file system is being updated).</p>
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
status?: LifeCycleState | undefined;
|
|
291
|
+
/**
|
|
292
|
+
* <p>Additional information about the file system status. This field provides more details when the status is <code>ERROR</code>, or during state transitions.</p>
|
|
293
|
+
* @public
|
|
294
|
+
*/
|
|
295
|
+
statusMessage?: string | undefined;
|
|
296
|
+
/**
|
|
297
|
+
* <p>The ARN of the IAM role used for S3 access.</p>
|
|
298
|
+
* @public
|
|
299
|
+
*/
|
|
300
|
+
roleArn?: string | undefined;
|
|
301
|
+
/**
|
|
302
|
+
* <p>The Amazon Web Services account ID of the file system owner.</p>
|
|
303
|
+
* @public
|
|
304
|
+
*/
|
|
305
|
+
ownerId?: string | undefined;
|
|
306
|
+
/**
|
|
307
|
+
* <p>The tags associated with the file system.</p>
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
tags?: Tag[] | undefined;
|
|
311
|
+
/**
|
|
312
|
+
* <p>The name of the file system, derived from the <code>Name</code> tag if present.</p>
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
name?: string | undefined;
|
|
316
|
+
}
|
|
317
|
+
/**
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
export interface CreateMountTargetRequest {
|
|
321
|
+
/**
|
|
322
|
+
* <p>The ID or Amazon Resource Name (ARN) of the S3 File System to create the mount target for.</p>
|
|
323
|
+
* @public
|
|
324
|
+
*/
|
|
325
|
+
fileSystemId: string | undefined;
|
|
326
|
+
/**
|
|
327
|
+
* <p>The ID of the subnet where the mount target will be created. The subnet must be in the same Amazon Web Services Region as the file system. For file systems with regional availability, you can create mount targets in any subnet within the Region. The subnet determines the Availability Zone where the mount target will be located.</p>
|
|
328
|
+
* @public
|
|
329
|
+
*/
|
|
330
|
+
subnetId: string | undefined;
|
|
331
|
+
/**
|
|
332
|
+
* <p>A specific IPv4 address to assign to the mount target. If not specified and the IP address type supports IPv4, an address is automatically assigned from the subnet's available IPv4 address range. The address must be within the subnet's CIDR block and not already in use.</p>
|
|
333
|
+
* @public
|
|
334
|
+
*/
|
|
335
|
+
ipv4Address?: string | undefined;
|
|
336
|
+
/**
|
|
337
|
+
* <p>A specific IPv6 address to assign to the mount target. If not specified and the IP address type supports IPv6, an address is automatically assigned from the subnet's available IPv6 address range. The address must be within the subnet's IPv6 CIDR block and not already in use.</p>
|
|
338
|
+
* @public
|
|
339
|
+
*/
|
|
340
|
+
ipv6Address?: string | undefined;
|
|
341
|
+
/**
|
|
342
|
+
* <p>The IP address type for the mount target. If not specified, <code>IPV4_ONLY</code> is used. The IP address type must match the IP configuration of the specified subnet.</p>
|
|
343
|
+
* @public
|
|
344
|
+
*/
|
|
345
|
+
ipAddressType?: IpAddressType | undefined;
|
|
346
|
+
/**
|
|
347
|
+
* <p>An array of VPC security group IDs to associate with the mount target's network interface. These security groups control network access to the mount target. If not specified, the default security group for the subnet's VPC is used. All security groups must belong to the same VPC as the subnet.</p>
|
|
348
|
+
* @public
|
|
349
|
+
*/
|
|
350
|
+
securityGroups?: string[] | undefined;
|
|
351
|
+
}
|
|
352
|
+
/**
|
|
353
|
+
* @public
|
|
354
|
+
*/
|
|
355
|
+
export interface CreateMountTargetResponse {
|
|
356
|
+
/**
|
|
357
|
+
* <p>The unique and consistent identifier of the Availability Zone where the mount target is located. For example, <code>use1-az1</code> is an Availability Zone ID for the <code>us-east-1</code> Amazon Web Services Region, and it has the same location in every Amazon Web Services account.</p>
|
|
358
|
+
* @public
|
|
359
|
+
*/
|
|
360
|
+
availabilityZoneId?: string | undefined;
|
|
361
|
+
/**
|
|
362
|
+
* <p>The Amazon Web Services account ID of the mount target owner.</p>
|
|
363
|
+
* @public
|
|
364
|
+
*/
|
|
365
|
+
ownerId: string | undefined;
|
|
366
|
+
/**
|
|
367
|
+
* <p>The ID of the mount target, assigned by S3 Files. This ID is used to reference the mount target in subsequent API calls.</p>
|
|
368
|
+
* @public
|
|
369
|
+
*/
|
|
370
|
+
mountTargetId: string | undefined;
|
|
371
|
+
/**
|
|
372
|
+
* <p>The ID of the S3 File System associated with the mount target.</p>
|
|
373
|
+
* @public
|
|
374
|
+
*/
|
|
375
|
+
fileSystemId?: string | undefined;
|
|
376
|
+
/**
|
|
377
|
+
* <p>The ID of the subnet where the mount target is located.</p>
|
|
378
|
+
* @public
|
|
379
|
+
*/
|
|
380
|
+
subnetId: string | undefined;
|
|
381
|
+
/**
|
|
382
|
+
* <p>The IPv4 address assigned to the mount target.</p>
|
|
383
|
+
* @public
|
|
384
|
+
*/
|
|
385
|
+
ipv4Address?: string | undefined;
|
|
386
|
+
/**
|
|
387
|
+
* <p>The IPv6 address assigned to the mount target.</p>
|
|
388
|
+
* @public
|
|
389
|
+
*/
|
|
390
|
+
ipv6Address?: string | undefined;
|
|
391
|
+
/**
|
|
392
|
+
* <p>The ID of the network interface that S3 Files created when it created the mount target. This network interface is managed by the service.</p>
|
|
393
|
+
* @public
|
|
394
|
+
*/
|
|
395
|
+
networkInterfaceId?: string | undefined;
|
|
396
|
+
/**
|
|
397
|
+
* <p>The ID of the VPC where the mount target is located.</p>
|
|
398
|
+
* @public
|
|
399
|
+
*/
|
|
400
|
+
vpcId?: string | undefined;
|
|
401
|
+
/**
|
|
402
|
+
* <p>The security groups associated with the mount target's network interface.</p>
|
|
403
|
+
* @public
|
|
404
|
+
*/
|
|
405
|
+
securityGroups?: string[] | undefined;
|
|
406
|
+
/**
|
|
407
|
+
* <p>The lifecycle state of the mount target. Valid values are: <code>AVAILABLE</code> (the mount target is available for use), <code>CREATING</code> (the mount target is being created), <code>DELETING</code> (the mount target is being deleted), <code>DELETED</code> (the mount target has been deleted), or <code>ERROR</code> (the mount target is in an error state), or <code>UPDATING</code> (the mount target is being updated).</p>
|
|
408
|
+
* @public
|
|
409
|
+
*/
|
|
410
|
+
status?: LifeCycleState | undefined;
|
|
411
|
+
/**
|
|
412
|
+
* <p>Additional information about the mount target status. This field provides more details when the status is <code>ERROR</code>, or during state transitions.</p>
|
|
413
|
+
* @public
|
|
414
|
+
*/
|
|
415
|
+
statusMessage?: string | undefined;
|
|
416
|
+
}
|
|
417
|
+
/**
|
|
418
|
+
* @public
|
|
419
|
+
*/
|
|
420
|
+
export interface DeleteAccessPointRequest {
|
|
421
|
+
/**
|
|
422
|
+
* <p>The ID or Amazon Resource Name (ARN) of the access point to delete.</p>
|
|
423
|
+
* @public
|
|
424
|
+
*/
|
|
425
|
+
accessPointId: string | undefined;
|
|
426
|
+
}
|
|
427
|
+
/**
|
|
428
|
+
* @public
|
|
429
|
+
*/
|
|
430
|
+
export interface DeleteFileSystemRequest {
|
|
431
|
+
/**
|
|
432
|
+
* <p>The ID or Amazon Resource Name (ARN) of the S3 File System to delete.</p>
|
|
433
|
+
* @public
|
|
434
|
+
*/
|
|
435
|
+
fileSystemId: string | undefined;
|
|
436
|
+
/**
|
|
437
|
+
* <p>If true, allows deletion of a file system that contains data pending export to S3. If false (the default), the deletion will fail if there is data that has not yet been exported to the S3 bucket. Use this parameter with caution as it may result in data loss.</p>
|
|
438
|
+
* @public
|
|
439
|
+
*/
|
|
440
|
+
forceDelete?: boolean | undefined;
|
|
441
|
+
}
|
|
442
|
+
/**
|
|
443
|
+
* @public
|
|
444
|
+
*/
|
|
445
|
+
export interface DeleteFileSystemPolicyRequest {
|
|
446
|
+
/**
|
|
447
|
+
* <p>The ID or Amazon Resource Name (ARN) of the S3 File System whose resource policy to delete.</p>
|
|
448
|
+
* @public
|
|
449
|
+
*/
|
|
450
|
+
fileSystemId: string | undefined;
|
|
451
|
+
}
|
|
452
|
+
/**
|
|
453
|
+
* @public
|
|
454
|
+
*/
|
|
455
|
+
export interface DeleteMountTargetRequest {
|
|
456
|
+
/**
|
|
457
|
+
* <p>The ID of the mount target to delete.</p>
|
|
458
|
+
* @public
|
|
459
|
+
*/
|
|
460
|
+
mountTargetId: string | undefined;
|
|
461
|
+
}
|
|
462
|
+
/**
|
|
463
|
+
* <p>Specifies a rule that controls when cached data expires from the file system based on last access time.</p>
|
|
464
|
+
* @public
|
|
465
|
+
*/
|
|
466
|
+
export interface ExpirationDataRule {
|
|
467
|
+
/**
|
|
468
|
+
* <p>The number of days after last access before cached data expires from the file system.</p>
|
|
469
|
+
* @public
|
|
470
|
+
*/
|
|
471
|
+
daysAfterLastAccess: number | undefined;
|
|
472
|
+
}
|
|
473
|
+
/**
|
|
474
|
+
* <p>Contains information about an S3 File System returned in list operations.</p>
|
|
475
|
+
* @public
|
|
476
|
+
*/
|
|
477
|
+
export interface ListFileSystemsDescription {
|
|
478
|
+
/**
|
|
479
|
+
* <p>The time when the file system was created.</p>
|
|
480
|
+
* @public
|
|
481
|
+
*/
|
|
482
|
+
creationTime: Date | undefined;
|
|
483
|
+
/**
|
|
484
|
+
* <p>The Amazon Resource Name (ARN) of the file system.</p>
|
|
485
|
+
* @public
|
|
486
|
+
*/
|
|
487
|
+
fileSystemArn: string | undefined;
|
|
488
|
+
/**
|
|
489
|
+
* <p>The ID of the file system.</p>
|
|
490
|
+
* @public
|
|
491
|
+
*/
|
|
492
|
+
fileSystemId: string | undefined;
|
|
493
|
+
/**
|
|
494
|
+
* <p>The name of the file system.</p>
|
|
495
|
+
* @public
|
|
496
|
+
*/
|
|
497
|
+
name?: string | undefined;
|
|
498
|
+
/**
|
|
499
|
+
* <p>The Amazon Resource Name (ARN) of the S3 bucket.</p>
|
|
500
|
+
* @public
|
|
501
|
+
*/
|
|
502
|
+
bucket: string | undefined;
|
|
503
|
+
/**
|
|
504
|
+
* <p>The current status of the file system.</p>
|
|
505
|
+
* @public
|
|
506
|
+
*/
|
|
507
|
+
status: LifeCycleState | undefined;
|
|
508
|
+
/**
|
|
509
|
+
* <p>Additional information about the file system status.</p>
|
|
510
|
+
* @public
|
|
511
|
+
*/
|
|
512
|
+
statusMessage?: string | undefined;
|
|
513
|
+
/**
|
|
514
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role used for S3 access.</p>
|
|
515
|
+
* @public
|
|
516
|
+
*/
|
|
517
|
+
roleArn: string | undefined;
|
|
518
|
+
/**
|
|
519
|
+
* <p>The Amazon Web Services account ID of the file system owner.</p>
|
|
520
|
+
* @public
|
|
521
|
+
*/
|
|
522
|
+
ownerId: string | undefined;
|
|
523
|
+
}
|
|
524
|
+
/**
|
|
525
|
+
* @public
|
|
526
|
+
*/
|
|
527
|
+
export interface GetAccessPointRequest {
|
|
528
|
+
/**
|
|
529
|
+
* <p>The ID or Amazon Resource Name (ARN) of the access point to retrieve information for.</p>
|
|
530
|
+
* @public
|
|
531
|
+
*/
|
|
532
|
+
accessPointId: string | undefined;
|
|
533
|
+
}
|
|
534
|
+
/**
|
|
535
|
+
* @public
|
|
536
|
+
*/
|
|
537
|
+
export interface GetAccessPointResponse {
|
|
538
|
+
/**
|
|
539
|
+
* <p>The ARN of the access point.</p>
|
|
540
|
+
* @public
|
|
541
|
+
*/
|
|
542
|
+
accessPointArn: string | undefined;
|
|
543
|
+
/**
|
|
544
|
+
* <p>The ID of the access point.</p>
|
|
545
|
+
* @public
|
|
546
|
+
*/
|
|
547
|
+
accessPointId: string | undefined;
|
|
548
|
+
/**
|
|
549
|
+
* <p>The client token used for idempotency when the access point was created.</p>
|
|
550
|
+
* @public
|
|
551
|
+
*/
|
|
552
|
+
clientToken: string | undefined;
|
|
553
|
+
/**
|
|
554
|
+
* <p>The ID of the S3 File System.</p>
|
|
555
|
+
* @public
|
|
556
|
+
*/
|
|
557
|
+
fileSystemId: string | undefined;
|
|
558
|
+
/**
|
|
559
|
+
* <p>The current status of the access point.</p>
|
|
560
|
+
* @public
|
|
561
|
+
*/
|
|
562
|
+
status: LifeCycleState | undefined;
|
|
563
|
+
/**
|
|
564
|
+
* <p>The Amazon Web Services account ID of the access point owner.</p>
|
|
565
|
+
* @public
|
|
566
|
+
*/
|
|
567
|
+
ownerId: string | undefined;
|
|
568
|
+
/**
|
|
569
|
+
* <p>The POSIX identity configured for this access point.</p>
|
|
570
|
+
* @public
|
|
571
|
+
*/
|
|
572
|
+
posixUser?: PosixUser | undefined;
|
|
573
|
+
/**
|
|
574
|
+
* <p>The root directory configuration for this access point.</p>
|
|
575
|
+
* @public
|
|
576
|
+
*/
|
|
577
|
+
rootDirectory?: RootDirectory | undefined;
|
|
578
|
+
/**
|
|
579
|
+
* <p>The tags associated with the access point.</p>
|
|
580
|
+
* @public
|
|
581
|
+
*/
|
|
582
|
+
tags?: Tag[] | undefined;
|
|
583
|
+
/**
|
|
584
|
+
* <p>The name of the access point.</p>
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
name?: string | undefined;
|
|
588
|
+
}
|
|
589
|
+
/**
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
export interface GetFileSystemRequest {
|
|
593
|
+
/**
|
|
594
|
+
* <p>The ID or Amazon Resource Name (ARN) of the S3 File System to retrieve information for.</p>
|
|
595
|
+
* @public
|
|
596
|
+
*/
|
|
597
|
+
fileSystemId: string | undefined;
|
|
598
|
+
}
|
|
599
|
+
/**
|
|
600
|
+
* @public
|
|
601
|
+
*/
|
|
602
|
+
export interface GetFileSystemResponse {
|
|
603
|
+
/**
|
|
604
|
+
* <p>The time when the file system was created.</p>
|
|
605
|
+
* @public
|
|
606
|
+
*/
|
|
607
|
+
creationTime?: Date | undefined;
|
|
608
|
+
/**
|
|
609
|
+
* <p>The Amazon Resource Name (ARN) of the file system.</p>
|
|
610
|
+
* @public
|
|
611
|
+
*/
|
|
612
|
+
fileSystemArn?: string | undefined;
|
|
613
|
+
/**
|
|
614
|
+
* <p>The ID of the file system.</p>
|
|
615
|
+
* @public
|
|
616
|
+
*/
|
|
617
|
+
fileSystemId?: string | undefined;
|
|
618
|
+
/**
|
|
619
|
+
* <p>The Amazon Resource Name (ARN) of the S3 bucket.</p>
|
|
620
|
+
* @public
|
|
621
|
+
*/
|
|
622
|
+
bucket?: string | undefined;
|
|
623
|
+
/**
|
|
624
|
+
* <p>The prefix in the S3 bucket that the file system provides access to.</p>
|
|
625
|
+
* @public
|
|
626
|
+
*/
|
|
627
|
+
prefix?: string | undefined;
|
|
628
|
+
/**
|
|
629
|
+
* <p>The client token used for idempotency when the file system was created.</p>
|
|
630
|
+
* @public
|
|
631
|
+
*/
|
|
632
|
+
clientToken?: string | undefined;
|
|
633
|
+
/**
|
|
634
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services KMS key used for encryption.</p>
|
|
635
|
+
* @public
|
|
636
|
+
*/
|
|
637
|
+
kmsKeyId?: string | undefined;
|
|
638
|
+
/**
|
|
639
|
+
* <p>The current status of the file system.</p>
|
|
640
|
+
* @public
|
|
641
|
+
*/
|
|
642
|
+
status?: LifeCycleState | undefined;
|
|
643
|
+
/**
|
|
644
|
+
* <p>Additional information about the file system status.</p>
|
|
645
|
+
* @public
|
|
646
|
+
*/
|
|
647
|
+
statusMessage?: string | undefined;
|
|
648
|
+
/**
|
|
649
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role used for S3 access.</p>
|
|
650
|
+
* @public
|
|
651
|
+
*/
|
|
652
|
+
roleArn?: string | undefined;
|
|
653
|
+
/**
|
|
654
|
+
* <p>The Amazon Web Services account ID of the file system owner.</p>
|
|
655
|
+
* @public
|
|
656
|
+
*/
|
|
657
|
+
ownerId?: string | undefined;
|
|
658
|
+
/**
|
|
659
|
+
* <p>The tags associated with the file system.</p>
|
|
660
|
+
* @public
|
|
661
|
+
*/
|
|
662
|
+
tags?: Tag[] | undefined;
|
|
663
|
+
/**
|
|
664
|
+
* <p>The name of the file system.</p>
|
|
665
|
+
* @public
|
|
666
|
+
*/
|
|
667
|
+
name?: string | undefined;
|
|
668
|
+
}
|
|
669
|
+
/**
|
|
670
|
+
* @public
|
|
671
|
+
*/
|
|
672
|
+
export interface GetFileSystemPolicyRequest {
|
|
673
|
+
/**
|
|
674
|
+
* <p>The ID or Amazon Resource Name (ARN) of the S3 File System whose resource policy to retrieve.</p>
|
|
675
|
+
* @public
|
|
676
|
+
*/
|
|
677
|
+
fileSystemId: string | undefined;
|
|
678
|
+
}
|
|
679
|
+
/**
|
|
680
|
+
* @public
|
|
681
|
+
*/
|
|
682
|
+
export interface GetFileSystemPolicyResponse {
|
|
683
|
+
/**
|
|
684
|
+
* <p>The ID of the file system.</p>
|
|
685
|
+
* @public
|
|
686
|
+
*/
|
|
687
|
+
fileSystemId: string | undefined;
|
|
688
|
+
/**
|
|
689
|
+
* <p>The JSON-formatted resource policy for the file system.</p>
|
|
690
|
+
* @public
|
|
691
|
+
*/
|
|
692
|
+
policy: string | undefined;
|
|
693
|
+
}
|
|
694
|
+
/**
|
|
695
|
+
* @public
|
|
696
|
+
*/
|
|
697
|
+
export interface GetMountTargetRequest {
|
|
698
|
+
/**
|
|
699
|
+
* <p>The ID of the mount target to retrieve information for.</p>
|
|
700
|
+
* @public
|
|
701
|
+
*/
|
|
702
|
+
mountTargetId: string | undefined;
|
|
703
|
+
}
|
|
704
|
+
/**
|
|
705
|
+
* @public
|
|
706
|
+
*/
|
|
707
|
+
export interface GetMountTargetResponse {
|
|
708
|
+
/**
|
|
709
|
+
* <p>The Availability Zone ID where the mount target is located.</p>
|
|
710
|
+
* @public
|
|
711
|
+
*/
|
|
712
|
+
availabilityZoneId?: string | undefined;
|
|
713
|
+
/**
|
|
714
|
+
* <p>The Amazon Web Services account ID of the mount target owner.</p>
|
|
715
|
+
* @public
|
|
716
|
+
*/
|
|
717
|
+
ownerId: string | undefined;
|
|
718
|
+
/**
|
|
719
|
+
* <p>The ID of the mount target.</p>
|
|
720
|
+
* @public
|
|
721
|
+
*/
|
|
722
|
+
mountTargetId: string | undefined;
|
|
723
|
+
/**
|
|
724
|
+
* <p>The ID of the file system.</p>
|
|
725
|
+
* @public
|
|
726
|
+
*/
|
|
727
|
+
fileSystemId?: string | undefined;
|
|
728
|
+
/**
|
|
729
|
+
* <p>The ID of the subnet where the mount target is located.</p>
|
|
730
|
+
* @public
|
|
731
|
+
*/
|
|
732
|
+
subnetId: string | undefined;
|
|
733
|
+
/**
|
|
734
|
+
* <p>The IPv4 address of the mount target.</p>
|
|
735
|
+
* @public
|
|
736
|
+
*/
|
|
737
|
+
ipv4Address?: string | undefined;
|
|
738
|
+
/**
|
|
739
|
+
* <p>The IPv6 address of the mount target.</p>
|
|
740
|
+
* @public
|
|
741
|
+
*/
|
|
742
|
+
ipv6Address?: string | undefined;
|
|
743
|
+
/**
|
|
744
|
+
* <p>The ID of the network interface associated with the mount target.</p>
|
|
745
|
+
* @public
|
|
746
|
+
*/
|
|
747
|
+
networkInterfaceId?: string | undefined;
|
|
748
|
+
/**
|
|
749
|
+
* <p>The ID of the VPC where the mount target is located.</p>
|
|
750
|
+
* @public
|
|
751
|
+
*/
|
|
752
|
+
vpcId?: string | undefined;
|
|
753
|
+
/**
|
|
754
|
+
* <p>The security groups associated with the mount target.</p>
|
|
755
|
+
* @public
|
|
756
|
+
*/
|
|
757
|
+
securityGroups?: string[] | undefined;
|
|
758
|
+
/**
|
|
759
|
+
* <p>The current status of the mount target.</p>
|
|
760
|
+
* @public
|
|
761
|
+
*/
|
|
762
|
+
status?: LifeCycleState | undefined;
|
|
763
|
+
/**
|
|
764
|
+
* <p>Additional information about the mount target status.</p>
|
|
765
|
+
* @public
|
|
766
|
+
*/
|
|
767
|
+
statusMessage?: string | undefined;
|
|
768
|
+
}
|
|
769
|
+
/**
|
|
770
|
+
* @public
|
|
771
|
+
*/
|
|
772
|
+
export interface GetSynchronizationConfigurationRequest {
|
|
773
|
+
/**
|
|
774
|
+
* <p>The ID or Amazon Resource Name (ARN) of the S3 File System to retrieve the synchronization configuration for.</p>
|
|
775
|
+
* @public
|
|
776
|
+
*/
|
|
777
|
+
fileSystemId: string | undefined;
|
|
778
|
+
}
|
|
779
|
+
/**
|
|
780
|
+
* <p>Specifies a rule that controls how data is imported from S3 into the file system.</p>
|
|
781
|
+
* @public
|
|
782
|
+
*/
|
|
783
|
+
export interface ImportDataRule {
|
|
784
|
+
/**
|
|
785
|
+
* <p>The S3 key prefix that scopes this import rule. Only objects with keys beginning with this prefix are subject to the rule.</p>
|
|
786
|
+
* @public
|
|
787
|
+
*/
|
|
788
|
+
prefix: string | undefined;
|
|
789
|
+
/**
|
|
790
|
+
* <p>The event that triggers data import. Valid values are <code>ON_DIRECTORY_FIRST_ACCESS</code> (import when a directory is first accessed) and <code>ON_FILE_ACCESS</code> (import when a file is accessed).</p>
|
|
791
|
+
* @public
|
|
792
|
+
*/
|
|
793
|
+
trigger: ImportTrigger | undefined;
|
|
794
|
+
/**
|
|
795
|
+
* <p>The upper size limit in bytes for this import rule. Only objects with a size strictly less than this value will have data imported into the file system.</p>
|
|
796
|
+
* @public
|
|
797
|
+
*/
|
|
798
|
+
sizeLessThan: number | undefined;
|
|
799
|
+
}
|
|
800
|
+
/**
|
|
801
|
+
* @public
|
|
802
|
+
*/
|
|
803
|
+
export interface GetSynchronizationConfigurationResponse {
|
|
804
|
+
/**
|
|
805
|
+
* <p>The version number of the synchronization configuration. Use this value with <code>PutSynchronizationConfiguration</code> to ensure optimistic concurrency control.</p>
|
|
806
|
+
* @public
|
|
807
|
+
*/
|
|
808
|
+
latestVersionNumber?: number | undefined;
|
|
809
|
+
/**
|
|
810
|
+
* <p>An array of import data rules that control how data is imported from S3 into the file system.</p>
|
|
811
|
+
* @public
|
|
812
|
+
*/
|
|
813
|
+
importDataRules: ImportDataRule[] | undefined;
|
|
814
|
+
/**
|
|
815
|
+
* <p>An array of expiration data rules that control when cached data expires from the file system.</p>
|
|
816
|
+
* @public
|
|
817
|
+
*/
|
|
818
|
+
expirationDataRules: ExpirationDataRule[] | undefined;
|
|
819
|
+
}
|
|
820
|
+
/**
|
|
821
|
+
* @public
|
|
822
|
+
*/
|
|
823
|
+
export interface ListAccessPointsRequest {
|
|
824
|
+
/**
|
|
825
|
+
* <p>The ID or Amazon Resource Name (ARN) of the S3 File System to list access points for.</p>
|
|
826
|
+
* @public
|
|
827
|
+
*/
|
|
828
|
+
fileSystemId: string | undefined;
|
|
829
|
+
/**
|
|
830
|
+
* <p>The maximum number of access points to return in a single response.</p>
|
|
831
|
+
* @public
|
|
832
|
+
*/
|
|
833
|
+
maxResults?: number | undefined;
|
|
834
|
+
/**
|
|
835
|
+
* <p>A pagination token returned from a previous call to continue listing access points.</p>
|
|
836
|
+
* @public
|
|
837
|
+
*/
|
|
838
|
+
nextToken?: string | undefined;
|
|
839
|
+
}
|
|
840
|
+
/**
|
|
841
|
+
* @public
|
|
842
|
+
*/
|
|
843
|
+
export interface ListAccessPointsResponse {
|
|
844
|
+
/**
|
|
845
|
+
* <p>A pagination token to use in a subsequent request if more results are available.</p>
|
|
846
|
+
* @public
|
|
847
|
+
*/
|
|
848
|
+
nextToken?: string | undefined;
|
|
849
|
+
/**
|
|
850
|
+
* <p>An array of access point descriptions.</p>
|
|
851
|
+
* @public
|
|
852
|
+
*/
|
|
853
|
+
accessPoints: ListAccessPointsDescription[] | undefined;
|
|
854
|
+
}
|
|
855
|
+
/**
|
|
856
|
+
* @public
|
|
857
|
+
*/
|
|
858
|
+
export interface ListFileSystemsRequest {
|
|
859
|
+
/**
|
|
860
|
+
* <p>Optional filter to list only file systems associated with the specified S3 bucket Amazon Resource Name (ARN). If provided, only file systems that provide access to this bucket will be returned in the response.</p>
|
|
861
|
+
* @public
|
|
862
|
+
*/
|
|
863
|
+
bucket?: string | undefined;
|
|
864
|
+
/**
|
|
865
|
+
* <p>The maximum number of file systems to return in a single response. If not specified, up to 100 file systems are returned.</p>
|
|
866
|
+
* @public
|
|
867
|
+
*/
|
|
868
|
+
maxResults?: number | undefined;
|
|
869
|
+
/**
|
|
870
|
+
* <p>A pagination token returned from a previous call to continue listing file systems.</p>
|
|
871
|
+
* @public
|
|
872
|
+
*/
|
|
873
|
+
nextToken?: string | undefined;
|
|
874
|
+
}
|
|
875
|
+
/**
|
|
876
|
+
* @public
|
|
877
|
+
*/
|
|
878
|
+
export interface ListFileSystemsResponse {
|
|
879
|
+
/**
|
|
880
|
+
* <p>A pagination token to use in a subsequent request if more results are available.</p>
|
|
881
|
+
* @public
|
|
882
|
+
*/
|
|
883
|
+
nextToken?: string | undefined;
|
|
884
|
+
/**
|
|
885
|
+
* <p>An array of file system descriptions.</p>
|
|
886
|
+
* @public
|
|
887
|
+
*/
|
|
888
|
+
fileSystems: ListFileSystemsDescription[] | undefined;
|
|
889
|
+
}
|
|
890
|
+
/**
|
|
891
|
+
* @public
|
|
892
|
+
*/
|
|
893
|
+
export interface ListMountTargetsRequest {
|
|
894
|
+
/**
|
|
895
|
+
* <p>Optional filter to list only mount targets associated with the specified S3 File System ID or Amazon Resource Name (ARN). If provided, only mount targets for this file system will be returned in the response.</p>
|
|
896
|
+
* @public
|
|
897
|
+
*/
|
|
898
|
+
fileSystemId?: string | undefined;
|
|
899
|
+
/**
|
|
900
|
+
* <p>Optional filter to list only mount targets associated with the specified access point ID or Amazon Resource Name (ARN).</p>
|
|
901
|
+
* @public
|
|
902
|
+
*/
|
|
903
|
+
accessPointId?: string | undefined;
|
|
904
|
+
/**
|
|
905
|
+
* <p>The maximum number of mount targets to return in a single response.</p>
|
|
906
|
+
* @public
|
|
907
|
+
*/
|
|
908
|
+
maxResults?: number | undefined;
|
|
909
|
+
/**
|
|
910
|
+
* <p>A pagination token returned from a previous call to continue listing mount targets.</p>
|
|
911
|
+
* @public
|
|
912
|
+
*/
|
|
913
|
+
nextToken?: string | undefined;
|
|
914
|
+
}
|
|
915
|
+
/**
|
|
916
|
+
* <p>Contains information about a mount target returned in list operations.</p>
|
|
917
|
+
* @public
|
|
918
|
+
*/
|
|
919
|
+
export interface ListMountTargetsDescription {
|
|
920
|
+
/**
|
|
921
|
+
* <p>The Availability Zone ID where the mount target is located.</p>
|
|
922
|
+
* @public
|
|
923
|
+
*/
|
|
924
|
+
availabilityZoneId?: string | undefined;
|
|
925
|
+
/**
|
|
926
|
+
* <p>The ID of the S3 File System.</p>
|
|
927
|
+
* @public
|
|
928
|
+
*/
|
|
929
|
+
fileSystemId?: string | undefined;
|
|
930
|
+
/**
|
|
931
|
+
* <p>The IPv4 address of the mount target.</p>
|
|
932
|
+
* @public
|
|
933
|
+
*/
|
|
934
|
+
ipv4Address?: string | undefined;
|
|
935
|
+
/**
|
|
936
|
+
* <p>The IPv6 address of the mount target.</p>
|
|
937
|
+
* @public
|
|
938
|
+
*/
|
|
939
|
+
ipv6Address?: string | undefined;
|
|
940
|
+
/**
|
|
941
|
+
* <p>The current status of the mount target.</p>
|
|
942
|
+
* @public
|
|
943
|
+
*/
|
|
944
|
+
status?: LifeCycleState | undefined;
|
|
945
|
+
/**
|
|
946
|
+
* <p>Additional information about the mount target status.</p>
|
|
947
|
+
* @public
|
|
948
|
+
*/
|
|
949
|
+
statusMessage?: string | undefined;
|
|
950
|
+
/**
|
|
951
|
+
* <p>The ID of the mount target.</p>
|
|
952
|
+
* @public
|
|
953
|
+
*/
|
|
954
|
+
mountTargetId: string | undefined;
|
|
955
|
+
/**
|
|
956
|
+
* <p>The ID of the network interface associated with the mount target.</p>
|
|
957
|
+
* @public
|
|
958
|
+
*/
|
|
959
|
+
networkInterfaceId?: string | undefined;
|
|
960
|
+
/**
|
|
961
|
+
* <p>The Amazon Web Services account ID of the mount target owner.</p>
|
|
962
|
+
* @public
|
|
963
|
+
*/
|
|
964
|
+
ownerId: string | undefined;
|
|
965
|
+
/**
|
|
966
|
+
* <p>The ID of the subnet where the mount target is located.</p>
|
|
967
|
+
* @public
|
|
968
|
+
*/
|
|
969
|
+
subnetId: string | undefined;
|
|
970
|
+
/**
|
|
971
|
+
* <p>The ID of the VPC where the mount target is located.</p>
|
|
972
|
+
* @public
|
|
973
|
+
*/
|
|
974
|
+
vpcId?: string | undefined;
|
|
975
|
+
}
|
|
976
|
+
/**
|
|
977
|
+
* @public
|
|
978
|
+
*/
|
|
979
|
+
export interface ListMountTargetsResponse {
|
|
980
|
+
/**
|
|
981
|
+
* <p>A pagination token to use in a subsequent request if more results are available.</p>
|
|
982
|
+
* @public
|
|
983
|
+
*/
|
|
984
|
+
nextToken?: string | undefined;
|
|
985
|
+
/**
|
|
986
|
+
* <p>An array of mount target descriptions.</p>
|
|
987
|
+
* @public
|
|
988
|
+
*/
|
|
989
|
+
mountTargets: ListMountTargetsDescription[] | undefined;
|
|
990
|
+
}
|
|
991
|
+
/**
|
|
992
|
+
* @public
|
|
993
|
+
*/
|
|
994
|
+
export interface ListTagsForResourceRequest {
|
|
995
|
+
/**
|
|
996
|
+
* <p>The ID or Amazon Resource Name (ARN) of the resource to list tags for.</p>
|
|
997
|
+
* @public
|
|
998
|
+
*/
|
|
999
|
+
resourceId: string | undefined;
|
|
1000
|
+
/**
|
|
1001
|
+
* <p>The maximum number of tags to return in a single response.</p>
|
|
1002
|
+
* @public
|
|
1003
|
+
*/
|
|
1004
|
+
maxResults?: number | undefined;
|
|
1005
|
+
/**
|
|
1006
|
+
* <p>A pagination token returned from a previous call to continue listing tags.</p>
|
|
1007
|
+
* @public
|
|
1008
|
+
*/
|
|
1009
|
+
nextToken?: string | undefined;
|
|
1010
|
+
}
|
|
1011
|
+
/**
|
|
1012
|
+
* @public
|
|
1013
|
+
*/
|
|
1014
|
+
export interface ListTagsForResourceResponse {
|
|
1015
|
+
/**
|
|
1016
|
+
* <p>An array of tags associated with the resource.</p>
|
|
1017
|
+
* @public
|
|
1018
|
+
*/
|
|
1019
|
+
tags?: Tag[] | undefined;
|
|
1020
|
+
/**
|
|
1021
|
+
* <p>A pagination token to use in a subsequent request if more results are available.</p>
|
|
1022
|
+
* @public
|
|
1023
|
+
*/
|
|
1024
|
+
nextToken?: string | undefined;
|
|
1025
|
+
}
|
|
1026
|
+
/**
|
|
1027
|
+
* @public
|
|
1028
|
+
*/
|
|
1029
|
+
export interface PutFileSystemPolicyRequest {
|
|
1030
|
+
/**
|
|
1031
|
+
* <p>The ID or Amazon Resource Name (ARN) of the S3 File System to apply the resource policy to.</p>
|
|
1032
|
+
* @public
|
|
1033
|
+
*/
|
|
1034
|
+
fileSystemId: string | undefined;
|
|
1035
|
+
/**
|
|
1036
|
+
* <p>The JSON-formatted resource policy to apply to the file system. The policy defines the permissions for accessing the file system. The policy must be a valid JSON document that follows IAM policy syntax.</p>
|
|
1037
|
+
* @public
|
|
1038
|
+
*/
|
|
1039
|
+
policy: string | undefined;
|
|
1040
|
+
}
|
|
1041
|
+
/**
|
|
1042
|
+
* @public
|
|
1043
|
+
*/
|
|
1044
|
+
export interface PutFileSystemPolicyResponse {
|
|
1045
|
+
}
|
|
1046
|
+
/**
|
|
1047
|
+
* @public
|
|
1048
|
+
*/
|
|
1049
|
+
export interface PutSynchronizationConfigurationRequest {
|
|
1050
|
+
/**
|
|
1051
|
+
* <p>The ID or Amazon Resource Name (ARN) of the S3 File System to configure synchronization for.</p>
|
|
1052
|
+
* @public
|
|
1053
|
+
*/
|
|
1054
|
+
fileSystemId: string | undefined;
|
|
1055
|
+
/**
|
|
1056
|
+
* <p>The version number of the current synchronization configuration. Omit this value when creating a synchronization configuration for the first time. For subsequent updates, provide this value for optimistic concurrency control. If the version number does not match the current configuration, the request fails with a <code>ConflictException</code>.</p>
|
|
1057
|
+
* @public
|
|
1058
|
+
*/
|
|
1059
|
+
latestVersionNumber?: number | undefined;
|
|
1060
|
+
/**
|
|
1061
|
+
* <p>An array of import data rules that control how data is imported from S3 into the file system.</p>
|
|
1062
|
+
* @public
|
|
1063
|
+
*/
|
|
1064
|
+
importDataRules: ImportDataRule[] | undefined;
|
|
1065
|
+
/**
|
|
1066
|
+
* <p>An array of expiration data rules that control when cached data expires from the file system.</p>
|
|
1067
|
+
* @public
|
|
1068
|
+
*/
|
|
1069
|
+
expirationDataRules: ExpirationDataRule[] | undefined;
|
|
1070
|
+
}
|
|
1071
|
+
/**
|
|
1072
|
+
* @public
|
|
1073
|
+
*/
|
|
1074
|
+
export interface PutSynchronizationConfigurationResponse {
|
|
1075
|
+
}
|
|
1076
|
+
/**
|
|
1077
|
+
* @public
|
|
1078
|
+
*/
|
|
1079
|
+
export interface TagResourceRequest {
|
|
1080
|
+
/**
|
|
1081
|
+
* <p>The ID or Amazon Resource Name (ARN) of the resource to add tags to.</p>
|
|
1082
|
+
* @public
|
|
1083
|
+
*/
|
|
1084
|
+
resourceId: string | undefined;
|
|
1085
|
+
/**
|
|
1086
|
+
* <p>An array of key-value pairs to add as tags to the resource.</p>
|
|
1087
|
+
* @public
|
|
1088
|
+
*/
|
|
1089
|
+
tags: Tag[] | undefined;
|
|
1090
|
+
}
|
|
1091
|
+
/**
|
|
1092
|
+
* @public
|
|
1093
|
+
*/
|
|
1094
|
+
export interface UntagResourceRequest {
|
|
1095
|
+
/**
|
|
1096
|
+
* <p>The ID or Amazon Resource Name (ARN) of the resource to remove tags from.</p>
|
|
1097
|
+
* @public
|
|
1098
|
+
*/
|
|
1099
|
+
resourceId: string | undefined;
|
|
1100
|
+
/**
|
|
1101
|
+
* <p>An array of tag keys to remove from the resource.</p>
|
|
1102
|
+
* @public
|
|
1103
|
+
*/
|
|
1104
|
+
tagKeys: string[] | undefined;
|
|
1105
|
+
}
|
|
1106
|
+
/**
|
|
1107
|
+
* @public
|
|
1108
|
+
*/
|
|
1109
|
+
export interface UpdateMountTargetRequest {
|
|
1110
|
+
/**
|
|
1111
|
+
* <p>The ID of the mount target to update.</p>
|
|
1112
|
+
* @public
|
|
1113
|
+
*/
|
|
1114
|
+
mountTargetId: string | undefined;
|
|
1115
|
+
/**
|
|
1116
|
+
* <p>An array of VPC security group IDs to associate with the mount target's network interface. This replaces the existing security groups. All security groups must belong to the same VPC as the mount target's subnet.</p>
|
|
1117
|
+
* @public
|
|
1118
|
+
*/
|
|
1119
|
+
securityGroups: string[] | undefined;
|
|
1120
|
+
}
|
|
1121
|
+
/**
|
|
1122
|
+
* @public
|
|
1123
|
+
*/
|
|
1124
|
+
export interface UpdateMountTargetResponse {
|
|
1125
|
+
/**
|
|
1126
|
+
* <p>The Availability Zone ID where the mount target is located.</p>
|
|
1127
|
+
* @public
|
|
1128
|
+
*/
|
|
1129
|
+
availabilityZoneId?: string | undefined;
|
|
1130
|
+
/**
|
|
1131
|
+
* <p>The Amazon Web Services account ID of the mount target owner.</p>
|
|
1132
|
+
* @public
|
|
1133
|
+
*/
|
|
1134
|
+
ownerId: string | undefined;
|
|
1135
|
+
/**
|
|
1136
|
+
* <p>The ID of the mount target.</p>
|
|
1137
|
+
* @public
|
|
1138
|
+
*/
|
|
1139
|
+
mountTargetId: string | undefined;
|
|
1140
|
+
/**
|
|
1141
|
+
* <p>The ID of the S3 File System.</p>
|
|
1142
|
+
* @public
|
|
1143
|
+
*/
|
|
1144
|
+
fileSystemId?: string | undefined;
|
|
1145
|
+
/**
|
|
1146
|
+
* <p>The ID of the subnet where the mount target is located.</p>
|
|
1147
|
+
* @public
|
|
1148
|
+
*/
|
|
1149
|
+
subnetId: string | undefined;
|
|
1150
|
+
/**
|
|
1151
|
+
* <p>The IPv4 address of the mount target.</p>
|
|
1152
|
+
* @public
|
|
1153
|
+
*/
|
|
1154
|
+
ipv4Address?: string | undefined;
|
|
1155
|
+
/**
|
|
1156
|
+
* <p>The IPv6 address of the mount target.</p>
|
|
1157
|
+
* @public
|
|
1158
|
+
*/
|
|
1159
|
+
ipv6Address?: string | undefined;
|
|
1160
|
+
/**
|
|
1161
|
+
* <p>The ID of the network interface associated with the mount target.</p>
|
|
1162
|
+
* @public
|
|
1163
|
+
*/
|
|
1164
|
+
networkInterfaceId?: string | undefined;
|
|
1165
|
+
/**
|
|
1166
|
+
* <p>The ID of the VPC where the mount target is located.</p>
|
|
1167
|
+
* @public
|
|
1168
|
+
*/
|
|
1169
|
+
vpcId?: string | undefined;
|
|
1170
|
+
/**
|
|
1171
|
+
* <p>The security groups associated with the mount target.</p>
|
|
1172
|
+
* @public
|
|
1173
|
+
*/
|
|
1174
|
+
securityGroups?: string[] | undefined;
|
|
1175
|
+
/**
|
|
1176
|
+
* <p>The current status of the mount target.</p>
|
|
1177
|
+
* @public
|
|
1178
|
+
*/
|
|
1179
|
+
status?: LifeCycleState | undefined;
|
|
1180
|
+
/**
|
|
1181
|
+
* <p>Additional information about the mount target status.</p>
|
|
1182
|
+
* @public
|
|
1183
|
+
*/
|
|
1184
|
+
statusMessage?: string | undefined;
|
|
1185
|
+
}
|