@aws-sdk/client-fsx 3.288.0 → 3.290.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/AssociateFileSystemAliasesCommand.d.ts +10 -0
- package/dist-types/commands/CancelDataRepositoryTaskCommand.d.ts +16 -0
- package/dist-types/commands/CopyBackupCommand.d.ts +86 -0
- package/dist-types/commands/CreateBackupCommand.d.ts +75 -0
- package/dist-types/commands/CreateDataRepositoryAssociationCommand.d.ts +22 -0
- package/dist-types/commands/CreateDataRepositoryTaskCommand.d.ts +26 -0
- package/dist-types/commands/CreateFileCacheCommand.d.ts +25 -0
- package/dist-types/commands/CreateFileSystemCommand.d.ts +109 -0
- package/dist-types/commands/CreateFileSystemFromBackupCommand.d.ts +89 -0
- package/dist-types/commands/CreateSnapshotCommand.d.ts +14 -0
- package/dist-types/commands/CreateStorageVirtualMachineCommand.d.ts +25 -0
- package/dist-types/commands/CreateVolumeCommand.d.ts +28 -0
- package/dist-types/commands/CreateVolumeFromBackupCommand.d.ts +28 -0
- package/dist-types/commands/DeleteBackupCommand.d.ts +43 -0
- package/dist-types/commands/DeleteDataRepositoryAssociationCommand.d.ts +19 -0
- package/dist-types/commands/DeleteFileCacheCommand.d.ts +19 -0
- package/dist-types/commands/DeleteFileSystemCommand.d.ts +36 -0
- package/dist-types/commands/DeleteSnapshotCommand.d.ts +10 -0
- package/dist-types/commands/DeleteStorageVirtualMachineCommand.d.ts +15 -0
- package/dist-types/commands/DeleteVolumeCommand.d.ts +15 -0
- package/dist-types/commands/DescribeBackupsCommand.d.ts +55 -0
- package/dist-types/commands/DescribeDataRepositoryAssociationsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDataRepositoryTasksCommand.d.ts +13 -0
- package/dist-types/commands/DescribeFileCachesCommand.d.ts +10 -0
- package/dist-types/commands/DescribeFileSystemAliasesCommand.d.ts +10 -0
- package/dist-types/commands/DescribeFileSystemsCommand.d.ts +55 -0
- package/dist-types/commands/DescribeSnapshotsCommand.d.ts +10 -0
- package/dist-types/commands/DescribeStorageVirtualMachinesCommand.d.ts +10 -0
- package/dist-types/commands/DescribeVolumesCommand.d.ts +10 -0
- package/dist-types/commands/DisassociateFileSystemAliasesCommand.d.ts +10 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +38 -0
- package/dist-types/commands/ReleaseFileSystemNfsV3LocksCommand.d.ts +19 -0
- package/dist-types/commands/RestoreVolumeFromSnapshotCommand.d.ts +10 -0
- package/dist-types/commands/TagResourceCommand.d.ts +34 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +31 -0
- package/dist-types/commands/UpdateDataRepositoryAssociationCommand.d.ts +19 -0
- package/dist-types/commands/UpdateFileCacheCommand.d.ts +25 -0
- package/dist-types/commands/UpdateFileSystemCommand.d.ts +74 -0
- package/dist-types/commands/UpdateSnapshotCommand.d.ts +10 -0
- package/dist-types/commands/UpdateStorageVirtualMachineCommand.d.ts +18 -0
- package/dist-types/commands/UpdateVolumeCommand.d.ts +18 -0
- package/package.json +29 -29
|
@@ -36,6 +36,49 @@ export interface DeleteBackupCommandOutput extends DeleteBackupResponse, __Metad
|
|
|
36
36
|
* @see {@link DeleteBackupCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @throws {@link BackupBeingCopied} (client fault)
|
|
40
|
+
* <p>You can't delete a backup while it's being copied.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link BackupInProgress} (client fault)
|
|
43
|
+
* <p>Another backup is already under way. Wait for completion before initiating
|
|
44
|
+
* additional backups of this file system.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link BackupNotFound} (client fault)
|
|
47
|
+
* <p>No Amazon FSx backups were found based upon the supplied parameters.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link BackupRestoring} (client fault)
|
|
50
|
+
* <p>You can't delete a backup while it's being used to restore a file
|
|
51
|
+
* system.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link BadRequest} (client fault)
|
|
54
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link IncompatibleParameterError} (client fault)
|
|
57
|
+
* <p>The error returned when a second request is received with the same client request
|
|
58
|
+
* token but different parameters settings. A client request token should always uniquely
|
|
59
|
+
* identify a single request.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link InternalServerError} (server fault)
|
|
62
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
63
|
+
*
|
|
64
|
+
*
|
|
65
|
+
* @example To delete a backup
|
|
66
|
+
* ```javascript
|
|
67
|
+
* // This operation deletes an Amazon FSx file system backup.
|
|
68
|
+
* const input = {
|
|
69
|
+
* "BackupId": "backup-03e3c82e0183b7b6b"
|
|
70
|
+
* };
|
|
71
|
+
* const command = new DeleteBackupCommand(input);
|
|
72
|
+
* const response = await client.send(command);
|
|
73
|
+
* /* response ==
|
|
74
|
+
* {
|
|
75
|
+
* "BackupId": "backup-03e3c82e0183b7b6b",
|
|
76
|
+
* "Lifecycle": "DELETED"
|
|
77
|
+
* }
|
|
78
|
+
* *\/
|
|
79
|
+
* // example id: to-delete-a-file-system-1481847318399
|
|
80
|
+
* ```
|
|
81
|
+
*
|
|
39
82
|
*/
|
|
40
83
|
export declare class DeleteBackupCommand extends $Command<DeleteBackupCommandInput, DeleteBackupCommandOutput, FSxClientResolvedConfig> {
|
|
41
84
|
readonly input: DeleteBackupCommandInput;
|
|
@@ -35,6 +35,25 @@ export interface DeleteDataRepositoryAssociationCommandOutput extends DeleteData
|
|
|
35
35
|
* @see {@link DeleteDataRepositoryAssociationCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @throws {@link BadRequest} (client fault)
|
|
39
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link DataRepositoryAssociationNotFound} (client fault)
|
|
42
|
+
* <p>No data repository associations were found based upon the supplied parameters.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link IncompatibleParameterError} (client fault)
|
|
45
|
+
* <p>The error returned when a second request is received with the same client request
|
|
46
|
+
* token but different parameters settings. A client request token should always uniquely
|
|
47
|
+
* identify a single request.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link InternalServerError} (server fault)
|
|
50
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link ServiceLimitExceeded} (client fault)
|
|
53
|
+
* <p>An error indicating that a particular service limit was exceeded. You can increase
|
|
54
|
+
* some service limits by contacting Amazon Web Services Support.</p>
|
|
55
|
+
*
|
|
56
|
+
*
|
|
38
57
|
*/
|
|
39
58
|
export declare class DeleteDataRepositoryAssociationCommand extends $Command<DeleteDataRepositoryAssociationCommandInput, DeleteDataRepositoryAssociationCommandOutput, FSxClientResolvedConfig> {
|
|
40
59
|
readonly input: DeleteDataRepositoryAssociationCommandInput;
|
|
@@ -40,6 +40,25 @@ export interface DeleteFileCacheCommandOutput extends DeleteFileCacheResponse, _
|
|
|
40
40
|
* @see {@link DeleteFileCacheCommandOutput} for command's `response` shape.
|
|
41
41
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
42
42
|
*
|
|
43
|
+
* @throws {@link BadRequest} (client fault)
|
|
44
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link FileCacheNotFound} (client fault)
|
|
47
|
+
* <p>No caches were found based upon supplied parameters.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link IncompatibleParameterError} (client fault)
|
|
50
|
+
* <p>The error returned when a second request is received with the same client request
|
|
51
|
+
* token but different parameters settings. A client request token should always uniquely
|
|
52
|
+
* identify a single request.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link InternalServerError} (server fault)
|
|
55
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ServiceLimitExceeded} (client fault)
|
|
58
|
+
* <p>An error indicating that a particular service limit was exceeded. You can increase
|
|
59
|
+
* some service limits by contacting Amazon Web Services Support.</p>
|
|
60
|
+
*
|
|
61
|
+
*
|
|
43
62
|
*/
|
|
44
63
|
export declare class DeleteFileCacheCommand extends $Command<DeleteFileCacheCommandInput, DeleteFileCacheCommandOutput, FSxClientResolvedConfig> {
|
|
45
64
|
readonly input: DeleteFileCacheCommandInput;
|
|
@@ -51,6 +51,42 @@ export interface DeleteFileSystemCommandOutput extends DeleteFileSystemResponse,
|
|
|
51
51
|
* @see {@link DeleteFileSystemCommandOutput} for command's `response` shape.
|
|
52
52
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
53
53
|
*
|
|
54
|
+
* @throws {@link BadRequest} (client fault)
|
|
55
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link FileSystemNotFound} (client fault)
|
|
58
|
+
* <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link IncompatibleParameterError} (client fault)
|
|
61
|
+
* <p>The error returned when a second request is received with the same client request
|
|
62
|
+
* token but different parameters settings. A client request token should always uniquely
|
|
63
|
+
* identify a single request.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerError} (server fault)
|
|
66
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ServiceLimitExceeded} (client fault)
|
|
69
|
+
* <p>An error indicating that a particular service limit was exceeded. You can increase
|
|
70
|
+
* some service limits by contacting Amazon Web Services Support.</p>
|
|
71
|
+
*
|
|
72
|
+
*
|
|
73
|
+
* @example To delete a file system
|
|
74
|
+
* ```javascript
|
|
75
|
+
* // This operation deletes an Amazon FSx file system.
|
|
76
|
+
* const input = {
|
|
77
|
+
* "FileSystemId": "fs-0498eed5fe91001ec"
|
|
78
|
+
* };
|
|
79
|
+
* const command = new DeleteFileSystemCommand(input);
|
|
80
|
+
* const response = await client.send(command);
|
|
81
|
+
* /* response ==
|
|
82
|
+
* {
|
|
83
|
+
* "FileSystemId": "fs-0498eed5fe91001ec",
|
|
84
|
+
* "Lifecycle": "DELETING"
|
|
85
|
+
* }
|
|
86
|
+
* *\/
|
|
87
|
+
* // example id: to-delete-a-file-system-1481847318348
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
54
90
|
*/
|
|
55
91
|
export declare class DeleteFileSystemCommand extends $Command<DeleteFileSystemCommandInput, DeleteFileSystemCommandOutput, FSxClientResolvedConfig> {
|
|
56
92
|
readonly input: DeleteFileSystemCommandInput;
|
|
@@ -33,6 +33,16 @@ export interface DeleteSnapshotCommandOutput extends DeleteSnapshotResponse, __M
|
|
|
33
33
|
* @see {@link DeleteSnapshotCommandOutput} for command's `response` shape.
|
|
34
34
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
35
35
|
*
|
|
36
|
+
* @throws {@link BadRequest} (client fault)
|
|
37
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link InternalServerError} (server fault)
|
|
40
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link SnapshotNotFound} (client fault)
|
|
43
|
+
* <p>No Amazon FSx snapshots were found based on the supplied parameters.</p>
|
|
44
|
+
*
|
|
45
|
+
*
|
|
36
46
|
*/
|
|
37
47
|
export declare class DeleteSnapshotCommand extends $Command<DeleteSnapshotCommandInput, DeleteSnapshotCommandOutput, FSxClientResolvedConfig> {
|
|
38
48
|
readonly input: DeleteSnapshotCommandInput;
|
|
@@ -30,6 +30,21 @@ export interface DeleteStorageVirtualMachineCommandOutput extends DeleteStorageV
|
|
|
30
30
|
* @see {@link DeleteStorageVirtualMachineCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link BadRequest} (client fault)
|
|
34
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link IncompatibleParameterError} (client fault)
|
|
37
|
+
* <p>The error returned when a second request is received with the same client request
|
|
38
|
+
* token but different parameters settings. A client request token should always uniquely
|
|
39
|
+
* identify a single request.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InternalServerError} (server fault)
|
|
42
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link StorageVirtualMachineNotFound} (client fault)
|
|
45
|
+
* <p>No FSx for ONTAP SVMs were found based upon the supplied parameters.</p>
|
|
46
|
+
*
|
|
47
|
+
*
|
|
33
48
|
*/
|
|
34
49
|
export declare class DeleteStorageVirtualMachineCommand extends $Command<DeleteStorageVirtualMachineCommandInput, DeleteStorageVirtualMachineCommandOutput, FSxClientResolvedConfig> {
|
|
35
50
|
readonly input: DeleteStorageVirtualMachineCommandInput;
|
|
@@ -30,6 +30,21 @@ export interface DeleteVolumeCommandOutput extends DeleteVolumeResponse, __Metad
|
|
|
30
30
|
* @see {@link DeleteVolumeCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link BadRequest} (client fault)
|
|
34
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link IncompatibleParameterError} (client fault)
|
|
37
|
+
* <p>The error returned when a second request is received with the same client request
|
|
38
|
+
* token but different parameters settings. A client request token should always uniquely
|
|
39
|
+
* identify a single request.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InternalServerError} (server fault)
|
|
42
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link VolumeNotFound} (client fault)
|
|
45
|
+
* <p>No Amazon FSx volumes were found based upon the supplied parameters.</p>
|
|
46
|
+
*
|
|
47
|
+
*
|
|
33
48
|
*/
|
|
34
49
|
export declare class DeleteVolumeCommand extends $Command<DeleteVolumeCommandInput, DeleteVolumeCommandOutput, FSxClientResolvedConfig> {
|
|
35
50
|
readonly input: DeleteVolumeCommandInput;
|
|
@@ -54,6 +54,61 @@ export interface DescribeBackupsCommandOutput extends DescribeBackupsResponse, _
|
|
|
54
54
|
* @see {@link DescribeBackupsCommandOutput} for command's `response` shape.
|
|
55
55
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
56
56
|
*
|
|
57
|
+
* @throws {@link BackupNotFound} (client fault)
|
|
58
|
+
* <p>No Amazon FSx backups were found based upon the supplied parameters.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link BadRequest} (client fault)
|
|
61
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link FileSystemNotFound} (client fault)
|
|
64
|
+
* <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalServerError} (server fault)
|
|
67
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link VolumeNotFound} (client fault)
|
|
70
|
+
* <p>No Amazon FSx volumes were found based upon the supplied parameters.</p>
|
|
71
|
+
*
|
|
72
|
+
*
|
|
73
|
+
* @example To describe Amazon FSx backups
|
|
74
|
+
* ```javascript
|
|
75
|
+
* // This operation describes all of the Amazon FSx backups in an account.
|
|
76
|
+
* const input = {};
|
|
77
|
+
* const command = new DescribeBackupsCommand(input);
|
|
78
|
+
* const response = await client.send(command);
|
|
79
|
+
* /* response ==
|
|
80
|
+
* {
|
|
81
|
+
* "Backups": [
|
|
82
|
+
* {
|
|
83
|
+
* "BackupId": "backup-03e3c82e0183b7b6b",
|
|
84
|
+
* "CreationTime": "1481841524.0",
|
|
85
|
+
* "FileSystem": {
|
|
86
|
+
* "FileSystemId": "fs-0498eed5fe91001ec",
|
|
87
|
+
* "OwnerId": "012345678912",
|
|
88
|
+
* "StorageCapacity": 300,
|
|
89
|
+
* "WindowsConfiguration": {
|
|
90
|
+
* "ActiveDirectoryId": "d-1234abcd12",
|
|
91
|
+
* "AutomaticBackupRetentionDays": 30,
|
|
92
|
+
* "DailyAutomaticBackupStartTime": "05:00",
|
|
93
|
+
* "WeeklyMaintenanceStartTime": "1:05:00"
|
|
94
|
+
* }
|
|
95
|
+
* },
|
|
96
|
+
* "Lifecycle": "AVAILABLE",
|
|
97
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b",
|
|
98
|
+
* "Tags": [
|
|
99
|
+
* {
|
|
100
|
+
* "Key": "Name",
|
|
101
|
+
* "Value": "MyBackup"
|
|
102
|
+
* }
|
|
103
|
+
* ],
|
|
104
|
+
* "Type": "USER_INITIATED"
|
|
105
|
+
* }
|
|
106
|
+
* ]
|
|
107
|
+
* }
|
|
108
|
+
* *\/
|
|
109
|
+
* // example id: to-describe-backups-1481848448499
|
|
110
|
+
* ```
|
|
111
|
+
*
|
|
57
112
|
*/
|
|
58
113
|
export declare class DescribeBackupsCommand extends $Command<DescribeBackupsCommandInput, DescribeBackupsCommandOutput, FSxClientResolvedConfig> {
|
|
59
114
|
readonly input: DescribeBackupsCommandInput;
|
|
@@ -47,6 +47,22 @@ export interface DescribeDataRepositoryAssociationsCommandOutput extends Describ
|
|
|
47
47
|
* @see {@link DescribeDataRepositoryAssociationsCommandOutput} for command's `response` shape.
|
|
48
48
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
49
49
|
*
|
|
50
|
+
* @throws {@link BadRequest} (client fault)
|
|
51
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link DataRepositoryAssociationNotFound} (client fault)
|
|
54
|
+
* <p>No data repository associations were found based upon the supplied parameters.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link FileSystemNotFound} (client fault)
|
|
57
|
+
* <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InternalServerError} (server fault)
|
|
60
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InvalidDataRepositoryType} (client fault)
|
|
63
|
+
* <p>You have filtered the response to a data repository type that is not supported.</p>
|
|
64
|
+
*
|
|
65
|
+
*
|
|
50
66
|
*/
|
|
51
67
|
export declare class DescribeDataRepositoryAssociationsCommand extends $Command<DescribeDataRepositoryAssociationsCommandInput, DescribeDataRepositoryAssociationsCommandOutput, FSxClientResolvedConfig> {
|
|
52
68
|
readonly input: DescribeDataRepositoryAssociationsCommandInput;
|
|
@@ -38,6 +38,19 @@ export interface DescribeDataRepositoryTasksCommandOutput extends DescribeDataRe
|
|
|
38
38
|
* @see {@link DescribeDataRepositoryTasksCommandOutput} for command's `response` shape.
|
|
39
39
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
40
40
|
*
|
|
41
|
+
* @throws {@link BadRequest} (client fault)
|
|
42
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link DataRepositoryTaskNotFound} (client fault)
|
|
45
|
+
* <p>The data repository task or tasks you specified could not be found.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link FileSystemNotFound} (client fault)
|
|
48
|
+
* <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link InternalServerError} (server fault)
|
|
51
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
52
|
+
*
|
|
53
|
+
*
|
|
41
54
|
*/
|
|
42
55
|
export declare class DescribeDataRepositoryTasksCommand extends $Command<DescribeDataRepositoryTasksCommandInput, DescribeDataRepositoryTasksCommandOutput, FSxClientResolvedConfig> {
|
|
43
56
|
readonly input: DescribeDataRepositoryTasksCommandInput;
|
|
@@ -56,6 +56,16 @@ export interface DescribeFileCachesCommandOutput extends DescribeFileCachesRespo
|
|
|
56
56
|
* @see {@link DescribeFileCachesCommandOutput} for command's `response` shape.
|
|
57
57
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
58
58
|
*
|
|
59
|
+
* @throws {@link BadRequest} (client fault)
|
|
60
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link FileCacheNotFound} (client fault)
|
|
63
|
+
* <p>No caches were found based upon supplied parameters.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerError} (server fault)
|
|
66
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
67
|
+
*
|
|
68
|
+
*
|
|
59
69
|
*/
|
|
60
70
|
export declare class DescribeFileCachesCommand extends $Command<DescribeFileCachesCommandInput, DescribeFileCachesCommandOutput, FSxClientResolvedConfig> {
|
|
61
71
|
readonly input: DescribeFileCachesCommandInput;
|
|
@@ -31,6 +31,16 @@ export interface DescribeFileSystemAliasesCommandOutput extends DescribeFileSyst
|
|
|
31
31
|
* @see {@link DescribeFileSystemAliasesCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @throws {@link BadRequest} (client fault)
|
|
35
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link FileSystemNotFound} (client fault)
|
|
38
|
+
* <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link InternalServerError} (server fault)
|
|
41
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
42
|
+
*
|
|
43
|
+
*
|
|
34
44
|
*/
|
|
35
45
|
export declare class DescribeFileSystemAliasesCommand extends $Command<DescribeFileSystemAliasesCommandInput, DescribeFileSystemAliasesCommandOutput, FSxClientResolvedConfig> {
|
|
36
46
|
readonly input: DescribeFileSystemAliasesCommandInput;
|
|
@@ -56,6 +56,61 @@ export interface DescribeFileSystemsCommandOutput extends DescribeFileSystemsRes
|
|
|
56
56
|
* @see {@link DescribeFileSystemsCommandOutput} for command's `response` shape.
|
|
57
57
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
58
58
|
*
|
|
59
|
+
* @throws {@link BadRequest} (client fault)
|
|
60
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link FileSystemNotFound} (client fault)
|
|
63
|
+
* <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerError} (server fault)
|
|
66
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
67
|
+
*
|
|
68
|
+
*
|
|
69
|
+
* @example To describe an Amazon FSx file system
|
|
70
|
+
* ```javascript
|
|
71
|
+
* // This operation describes all of the Amazon FSx file systems in an account.
|
|
72
|
+
* const input = {};
|
|
73
|
+
* const command = new DescribeFileSystemsCommand(input);
|
|
74
|
+
* const response = await client.send(command);
|
|
75
|
+
* /* response ==
|
|
76
|
+
* {
|
|
77
|
+
* "FileSystems": [
|
|
78
|
+
* {
|
|
79
|
+
* "CreationTime": "1481841524.0",
|
|
80
|
+
* "DNSName": "fs-0498eed5fe91001ec.fsx.com",
|
|
81
|
+
* "FileSystemId": "fs-0498eed5fe91001ec",
|
|
82
|
+
* "KmsKeyId": "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6",
|
|
83
|
+
* "Lifecycle": "AVAILABLE",
|
|
84
|
+
* "NetworkInterfaceIds": [
|
|
85
|
+
* "eni-abcd1234"
|
|
86
|
+
* ],
|
|
87
|
+
* "OwnerId": "012345678912",
|
|
88
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
|
|
89
|
+
* "StorageCapacity": 300,
|
|
90
|
+
* "SubnetIds": [
|
|
91
|
+
* "subnet-1234abcd"
|
|
92
|
+
* ],
|
|
93
|
+
* "Tags": [
|
|
94
|
+
* {
|
|
95
|
+
* "Key": "Name",
|
|
96
|
+
* "Value": "MyFileSystem"
|
|
97
|
+
* }
|
|
98
|
+
* ],
|
|
99
|
+
* "VpcId": "vpc-ab1234cd",
|
|
100
|
+
* "WindowsConfiguration": {
|
|
101
|
+
* "ActiveDirectoryId": "d-1234abcd12",
|
|
102
|
+
* "AutomaticBackupRetentionDays": 30,
|
|
103
|
+
* "DailyAutomaticBackupStartTime": "05:00",
|
|
104
|
+
* "ThroughputCapacity": 8,
|
|
105
|
+
* "WeeklyMaintenanceStartTime": "1:05:00"
|
|
106
|
+
* }
|
|
107
|
+
* }
|
|
108
|
+
* ]
|
|
109
|
+
* }
|
|
110
|
+
* *\/
|
|
111
|
+
* // example id: to-describe-a-file-systems-1481848448460
|
|
112
|
+
* ```
|
|
113
|
+
*
|
|
59
114
|
*/
|
|
60
115
|
export declare class DescribeFileSystemsCommand extends $Command<DescribeFileSystemsCommandInput, DescribeFileSystemsCommandOutput, FSxClientResolvedConfig> {
|
|
61
116
|
readonly input: DescribeFileSystemsCommandInput;
|
|
@@ -55,6 +55,16 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsRespons
|
|
|
55
55
|
* @see {@link DescribeSnapshotsCommandOutput} for command's `response` shape.
|
|
56
56
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
57
57
|
*
|
|
58
|
+
* @throws {@link BadRequest} (client fault)
|
|
59
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link InternalServerError} (server fault)
|
|
62
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link SnapshotNotFound} (client fault)
|
|
65
|
+
* <p>No Amazon FSx snapshots were found based on the supplied parameters.</p>
|
|
66
|
+
*
|
|
67
|
+
*
|
|
58
68
|
*/
|
|
59
69
|
export declare class DescribeSnapshotsCommand extends $Command<DescribeSnapshotsCommandInput, DescribeSnapshotsCommandOutput, FSxClientResolvedConfig> {
|
|
60
70
|
readonly input: DescribeSnapshotsCommandInput;
|
|
@@ -29,6 +29,16 @@ export interface DescribeStorageVirtualMachinesCommandOutput extends DescribeSto
|
|
|
29
29
|
* @see {@link DescribeStorageVirtualMachinesCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link BadRequest} (client fault)
|
|
33
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InternalServerError} (server fault)
|
|
36
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link StorageVirtualMachineNotFound} (client fault)
|
|
39
|
+
* <p>No FSx for ONTAP SVMs were found based upon the supplied parameters.</p>
|
|
40
|
+
*
|
|
41
|
+
*
|
|
32
42
|
*/
|
|
33
43
|
export declare class DescribeStorageVirtualMachinesCommand extends $Command<DescribeStorageVirtualMachinesCommandInput, DescribeStorageVirtualMachinesCommandOutput, FSxClientResolvedConfig> {
|
|
34
44
|
readonly input: DescribeStorageVirtualMachinesCommandInput;
|
|
@@ -30,6 +30,16 @@ export interface DescribeVolumesCommandOutput extends DescribeVolumesResponse, _
|
|
|
30
30
|
* @see {@link DescribeVolumesCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link BadRequest} (client fault)
|
|
34
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link InternalServerError} (server fault)
|
|
37
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link VolumeNotFound} (client fault)
|
|
40
|
+
* <p>No Amazon FSx volumes were found based upon the supplied parameters.</p>
|
|
41
|
+
*
|
|
42
|
+
*
|
|
33
43
|
*/
|
|
34
44
|
export declare class DescribeVolumesCommand extends $Command<DescribeVolumesCommandInput, DescribeVolumesCommandOutput, FSxClientResolvedConfig> {
|
|
35
45
|
readonly input: DescribeVolumesCommandInput;
|
|
@@ -37,6 +37,16 @@ export interface DisassociateFileSystemAliasesCommandOutput extends Disassociate
|
|
|
37
37
|
* @see {@link DisassociateFileSystemAliasesCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @throws {@link BadRequest} (client fault)
|
|
41
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link FileSystemNotFound} (client fault)
|
|
44
|
+
* <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InternalServerError} (server fault)
|
|
47
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
48
|
+
*
|
|
49
|
+
*
|
|
40
50
|
*/
|
|
41
51
|
export declare class DisassociateFileSystemAliasesCommand extends $Command<DisassociateFileSystemAliasesCommandInput, DisassociateFileSystemAliasesCommandOutput, FSxClientResolvedConfig> {
|
|
42
52
|
readonly input: DisassociateFileSystemAliasesCommandInput;
|
|
@@ -52,6 +52,44 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
52
52
|
* @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
|
|
53
53
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
54
54
|
*
|
|
55
|
+
* @throws {@link BadRequest} (client fault)
|
|
56
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link InternalServerError} (server fault)
|
|
59
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link NotServiceResourceError} (client fault)
|
|
62
|
+
* <p>The resource specified for the tagging operation is not a resource type owned by
|
|
63
|
+
* Amazon FSx. Use the API of the relevant service to perform the operation. </p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ResourceDoesNotSupportTagging} (client fault)
|
|
66
|
+
* <p>The resource specified does not support tagging. </p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ResourceNotFound} (client fault)
|
|
69
|
+
* <p>The resource specified by the Amazon Resource Name (ARN) can't be found.</p>
|
|
70
|
+
*
|
|
71
|
+
*
|
|
72
|
+
* @example To list tags for a resource
|
|
73
|
+
* ```javascript
|
|
74
|
+
* // This operation lists tags for an Amazon FSx resource.
|
|
75
|
+
* const input = {
|
|
76
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec"
|
|
77
|
+
* };
|
|
78
|
+
* const command = new ListTagsForResourceCommand(input);
|
|
79
|
+
* const response = await client.send(command);
|
|
80
|
+
* /* response ==
|
|
81
|
+
* {
|
|
82
|
+
* "Tags": [
|
|
83
|
+
* {
|
|
84
|
+
* "Key": "Name",
|
|
85
|
+
* "Value": "MyFileSystem"
|
|
86
|
+
* }
|
|
87
|
+
* ]
|
|
88
|
+
* }
|
|
89
|
+
* *\/
|
|
90
|
+
* // example id: to-list-tags-for-a-fsx-resource-1481847318372
|
|
91
|
+
* ```
|
|
92
|
+
*
|
|
55
93
|
*/
|
|
56
94
|
export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, FSxClientResolvedConfig> {
|
|
57
95
|
readonly input: ListTagsForResourceCommandInput;
|
|
@@ -30,6 +30,25 @@ export interface ReleaseFileSystemNfsV3LocksCommandOutput extends ReleaseFileSys
|
|
|
30
30
|
* @see {@link ReleaseFileSystemNfsV3LocksCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link BadRequest} (client fault)
|
|
34
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link FileSystemNotFound} (client fault)
|
|
37
|
+
* <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link IncompatibleParameterError} (client fault)
|
|
40
|
+
* <p>The error returned when a second request is received with the same client request
|
|
41
|
+
* token but different parameters settings. A client request token should always uniquely
|
|
42
|
+
* identify a single request.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link InternalServerError} (server fault)
|
|
45
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ServiceLimitExceeded} (client fault)
|
|
48
|
+
* <p>An error indicating that a particular service limit was exceeded. You can increase
|
|
49
|
+
* some service limits by contacting Amazon Web Services Support.</p>
|
|
50
|
+
*
|
|
51
|
+
*
|
|
33
52
|
*/
|
|
34
53
|
export declare class ReleaseFileSystemNfsV3LocksCommand extends $Command<ReleaseFileSystemNfsV3LocksCommandInput, ReleaseFileSystemNfsV3LocksCommandOutput, FSxClientResolvedConfig> {
|
|
35
54
|
readonly input: ReleaseFileSystemNfsV3LocksCommandInput;
|
|
@@ -30,6 +30,16 @@ export interface RestoreVolumeFromSnapshotCommandOutput extends RestoreVolumeFro
|
|
|
30
30
|
* @see {@link RestoreVolumeFromSnapshotCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link BadRequest} (client fault)
|
|
34
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link InternalServerError} (server fault)
|
|
37
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link VolumeNotFound} (client fault)
|
|
40
|
+
* <p>No Amazon FSx volumes were found based upon the supplied parameters.</p>
|
|
41
|
+
*
|
|
42
|
+
*
|
|
33
43
|
*/
|
|
34
44
|
export declare class RestoreVolumeFromSnapshotCommand extends $Command<RestoreVolumeFromSnapshotCommandInput, RestoreVolumeFromSnapshotCommandOutput, FSxClientResolvedConfig> {
|
|
35
45
|
readonly input: RestoreVolumeFromSnapshotCommandInput;
|
|
@@ -29,6 +29,40 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
29
29
|
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link BadRequest} (client fault)
|
|
33
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InternalServerError} (server fault)
|
|
36
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link NotServiceResourceError} (client fault)
|
|
39
|
+
* <p>The resource specified for the tagging operation is not a resource type owned by
|
|
40
|
+
* Amazon FSx. Use the API of the relevant service to perform the operation. </p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link ResourceDoesNotSupportTagging} (client fault)
|
|
43
|
+
* <p>The resource specified does not support tagging. </p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link ResourceNotFound} (client fault)
|
|
46
|
+
* <p>The resource specified by the Amazon Resource Name (ARN) can't be found.</p>
|
|
47
|
+
*
|
|
48
|
+
*
|
|
49
|
+
* @example To tag a resource
|
|
50
|
+
* ```javascript
|
|
51
|
+
* // This operation tags an Amazon FSx resource.
|
|
52
|
+
* const input = {
|
|
53
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
|
|
54
|
+
* "Tags": [
|
|
55
|
+
* {
|
|
56
|
+
* "Key": "Name",
|
|
57
|
+
* "Value": "MyFileSystem"
|
|
58
|
+
* }
|
|
59
|
+
* ]
|
|
60
|
+
* };
|
|
61
|
+
* const command = new TagResourceCommand(input);
|
|
62
|
+
* await client.send(command);
|
|
63
|
+
* // example id: to-tag-a-fsx-resource-1481847318371
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
32
66
|
*/
|
|
33
67
|
export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, FSxClientResolvedConfig> {
|
|
34
68
|
readonly input: TagResourceCommandInput;
|
|
@@ -29,6 +29,37 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
|
|
|
29
29
|
* @see {@link UntagResourceCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link BadRequest} (client fault)
|
|
33
|
+
* <p>A generic error indicating a failure with a client request.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InternalServerError} (server fault)
|
|
36
|
+
* <p>A generic error indicating a server-side failure.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link NotServiceResourceError} (client fault)
|
|
39
|
+
* <p>The resource specified for the tagging operation is not a resource type owned by
|
|
40
|
+
* Amazon FSx. Use the API of the relevant service to perform the operation. </p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link ResourceDoesNotSupportTagging} (client fault)
|
|
43
|
+
* <p>The resource specified does not support tagging. </p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link ResourceNotFound} (client fault)
|
|
46
|
+
* <p>The resource specified by the Amazon Resource Name (ARN) can't be found.</p>
|
|
47
|
+
*
|
|
48
|
+
*
|
|
49
|
+
* @example To untag a resource
|
|
50
|
+
* ```javascript
|
|
51
|
+
* // This operation untags an Amazon FSx resource.
|
|
52
|
+
* const input = {
|
|
53
|
+
* "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec",
|
|
54
|
+
* "TagKeys": [
|
|
55
|
+
* "Name"
|
|
56
|
+
* ]
|
|
57
|
+
* };
|
|
58
|
+
* const command = new UntagResourceCommand(input);
|
|
59
|
+
* await client.send(command);
|
|
60
|
+
* // example id: to-untag-a-fsx-resource-1481847318373
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
32
63
|
*/
|
|
33
64
|
export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, FSxClientResolvedConfig> {
|
|
34
65
|
readonly input: UntagResourceCommandInput;
|